Class Tool
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Tool.Builder,
Tool>
Information about a tool. Tools are used in a simulation job.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic Tool.Builder
builder()
final String
command()
Command-line arguments for the tool.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final ExitBehavior
Exit behavior determines what happens when your tool quits running.final String
Exit behavior determines what happens when your tool quits running.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final String
name()
The name of the tool.static Class
<? extends Tool.Builder> final Boolean
Boolean indicating whether logs will be recorded in CloudWatch for the tool.final Boolean
streamUI()
Boolean indicating whether a streaming session will be configured for the tool.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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 isFalse
.- 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 isFalse
.
-
name
The name of the tool.
- Returns:
- The name of the tool.
-
command
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.
-
streamOutputToCloudWatch
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
.
-
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 isRESTART
.If the service returns an enum value that is not available in the current SDK version,
exitBehavior
will returnExitBehavior.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromexitBehaviorAsString()
.- 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 isRESTART
. - See Also:
-
exitBehaviorAsString
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 isRESTART
.If the service returns an enum value that is not available in the current SDK version,
exitBehavior
will returnExitBehavior.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromexitBehaviorAsString()
.- 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 isRESTART
. - See Also:
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<Tool.Builder,
Tool> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-