Tool (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.robomaker.model.Tool

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Tool
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Information about a tool. Tools are used in a simulation job.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Tool()

Constructors
Constructor and Description
`Tool()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Tool`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getCommand()` Command-line arguments for the tool.
`String`	`getExitBehavior()` Exit behavior determines what happens when your tool quits running.
`String`	`getName()` The name of the tool.
`Boolean`	`getStreamOutputToCloudWatch()` Boolean indicating whether logs will be recorded in CloudWatch for the tool.
`Boolean`	`getStreamUI()` Boolean indicating whether a streaming session will be configured for the tool.
`int`	`hashCode()`
`Boolean`	`isStreamOutputToCloudWatch()` Boolean indicating whether logs will be recorded in CloudWatch for the tool.
`Boolean`	`isStreamUI()` Boolean indicating whether a streaming session will be configured for the tool.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setCommand(String command)` Command-line arguments for the tool.
`void`	`setExitBehavior(String exitBehavior)` Exit behavior determines what happens when your tool quits running.
`void`	`setName(String name)` The name of the tool.
`void`	`setStreamOutputToCloudWatch(Boolean streamOutputToCloudWatch)` Boolean indicating whether logs will be recorded in CloudWatch for the tool.
`void`	`setStreamUI(Boolean streamUI)` Boolean indicating whether a streaming session will be configured for the tool.
`String`	`toString()` Returns a string representation of this object.
`Tool`	`withCommand(String command)` Command-line arguments for the tool.
`Tool`	`withExitBehavior(ExitBehavior exitBehavior)` Exit behavior determines what happens when your tool quits running.
`Tool`	`withExitBehavior(String exitBehavior)` Exit behavior determines what happens when your tool quits running.
`Tool`	`withName(String name)` The name of the tool.
`Tool`	`withStreamOutputToCloudWatch(Boolean streamOutputToCloudWatch)` Boolean indicating whether logs will be recorded in CloudWatch for the tool.
`Tool`	`withStreamUI(Boolean streamUI)` Boolean indicating whether a streaming session will be configured for the tool.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Tool
```
public Tool()
```
- Method Detail
  - setStreamUI
```
public void setStreamUI(Boolean streamUI)
```
    Boolean indicating whether a streaming session will be configured for the tool. If True, AWS RoboMaker will configure a connection so you can interact with the tool as it is running in the simulation. It must have a graphical user interface. The default is False.
    
    Parameters:
    
    streamUI - Boolean indicating whether a streaming session will be configured for the tool. If True, AWS RoboMaker will configure a connection so you can interact with the tool as it is running in the simulation. It must have a graphical user interface. The default is False.
  - getStreamUI
```
public Boolean getStreamUI()
```
    Boolean indicating whether a streaming session will be configured for the tool. If True, AWS RoboMaker will configure a connection so you can interact with the tool as it is running in the simulation. It must have a graphical user interface. The default is False.
    
    Returns:
    
    Boolean indicating whether a streaming session will be configured for the tool. If True, AWS RoboMaker will configure a connection so you can interact with the tool as it is running in the simulation. It must have a graphical user interface. The default is False.
  - withStreamUI
```
public Tool withStreamUI(Boolean streamUI)
```
    Boolean indicating whether a streaming session will be configured for the tool. If True, AWS RoboMaker will configure a connection so you can interact with the tool as it is running in the simulation. It must have a graphical user interface. The default is False.
    
    Parameters:
    
    streamUI - Boolean indicating whether a streaming session will be configured for the tool. If True, AWS RoboMaker will configure a connection so you can interact with the tool as it is running in the simulation. It must have a graphical user interface. The default is False.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isStreamUI
```
public Boolean isStreamUI()
```
    Boolean indicating whether a streaming session will be configured for the tool. If True, AWS RoboMaker will configure a connection so you can interact with the tool as it is running in the simulation. It must have a graphical user interface. The default is False.
    
    Returns:
    
    Boolean indicating whether a streaming session will be configured for the tool. If True, AWS RoboMaker will configure a connection so you can interact with the tool as it is running in the simulation. It must have a graphical user interface. The default is False.
  - setName
```
public void setName(String name)
```
    The name of the tool.
    
    Parameters:
    
    name - The name of the tool.
  - getName
```
public String getName()
```
    The name of the tool.
    
    Returns:
    
    The name of the tool.
  - withName
```
public Tool withName(String name)
```
    The name of the tool.
    
    Parameters:
    
    name - The name of the tool.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCommand
```
public void setCommand(String command)
```
    Command-line arguments for the tool. It must include the tool executable name.
    
    Parameters:
    
    command - Command-line arguments for the tool. It must include the tool executable name.
  - getCommand
```
public String getCommand()
```
    Command-line arguments for the tool. It must include the tool executable name.
    
    Returns:
    
    Command-line arguments for the tool. It must include the tool executable name.
  - withCommand
```
public Tool withCommand(String command)
```
    Command-line arguments for the tool. It must include the tool executable name.
    
    Parameters:
    
    command - Command-line arguments for the tool. It must include the tool executable name.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStreamOutputToCloudWatch
```
public void setStreamOutputToCloudWatch(Boolean streamOutputToCloudWatch)
```
    Boolean indicating whether logs will be recorded in CloudWatch for the tool. The default is False.
    
    Parameters:
    
    streamOutputToCloudWatch - Boolean indicating whether logs will be recorded in CloudWatch for the tool. The default is False.
  - getStreamOutputToCloudWatch
```
public Boolean getStreamOutputToCloudWatch()
```
    Boolean indicating whether logs will be recorded in CloudWatch for the tool. The default is False.
    
    Returns:
    
    Boolean indicating whether logs will be recorded in CloudWatch for the tool. The default is False.
  - withStreamOutputToCloudWatch
```
public Tool withStreamOutputToCloudWatch(Boolean streamOutputToCloudWatch)
```
    Boolean indicating whether logs will be recorded in CloudWatch for the tool. The default is False.
    
    Parameters:
    
    streamOutputToCloudWatch - Boolean indicating whether logs will be recorded in CloudWatch for the tool. The default is False.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isStreamOutputToCloudWatch
```
public Boolean isStreamOutputToCloudWatch()
```
    Boolean indicating whether logs will be recorded in CloudWatch for the tool. The default is False.
    
    Returns:
    
    Boolean indicating whether logs will be recorded in CloudWatch for the tool. The default is False.
  - setExitBehavior
```
public void setExitBehavior(String exitBehavior)
```
    Exit behavior determines what happens when your tool quits running. RESTART will cause your tool to be restarted. FAIL will cause your job to exit. The default is RESTART.
    
    Parameters:
    
    exitBehavior - Exit behavior determines what happens when your tool quits running. RESTART will cause your tool to be restarted. FAIL will cause your job to exit. The default is RESTART.
    
    See Also:
    
    ExitBehavior
  - getExitBehavior
```
public String getExitBehavior()
```
    Exit behavior determines what happens when your tool quits running. RESTART will cause your tool to be restarted. FAIL will cause your job to exit. The default is RESTART.
    
    Returns:
    
    Exit behavior determines what happens when your tool quits running. RESTART will cause your tool to be restarted. FAIL will cause your job to exit. The default is RESTART.
    
    See Also:
    
    ExitBehavior
  - withExitBehavior
```
public Tool withExitBehavior(String exitBehavior)
```
    Exit behavior determines what happens when your tool quits running. RESTART will cause your tool to be restarted. FAIL will cause your job to exit. The default is RESTART.
    
    Parameters:
    
    exitBehavior - Exit behavior determines what happens when your tool quits running. RESTART will cause your tool to be restarted. FAIL will cause your job to exit. The default is RESTART.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ExitBehavior
  - withExitBehavior
```
public Tool withExitBehavior(ExitBehavior exitBehavior)
```
    Exit behavior determines what happens when your tool quits running. RESTART will cause your tool to be restarted. FAIL will cause your job to exit. The default is RESTART.
    
    Parameters:
    
    exitBehavior - Exit behavior determines what happens when your tool quits running. RESTART will cause your tool to be restarted. FAIL will cause your job to exit. The default is RESTART.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ExitBehavior
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public Tool clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.773

Class Tool

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Tool

Method Detail

setStreamUI

getStreamUI

withStreamUI

isStreamUI

setName

getName

withName

setCommand

getCommand

withCommand

setStreamOutputToCloudWatch

getStreamOutputToCloudWatch

withStreamOutputToCloudWatch

isStreamOutputToCloudWatch

setExitBehavior

getExitBehavior

withExitBehavior

withExitBehavior

toString

equals

hashCode

clone

marshall