Package software.amazon.awssdk.services.robomaker.model

Class Tool

java.lang.Object

software.amazon.awssdk.services.robomaker.model.Tool

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Tool.Builder,Tool>

@Generated("software.amazon.awssdk:codegen")
public final class Tool
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Tool.Builder,Tool>

Information about a tool. Tools are used in a simulation job.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Tool.Builder

Method Summary

Modifier and Type	Method	Description
static Tool.Builder	builder()
String	command()	Command-line arguments for the tool.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
ExitBehavior	exitBehavior()	Exit behavior determines what happens when your tool quits running.
String	exitBehaviorAsString()	Exit behavior determines what happens when your tool quits running.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	name()	The name of the tool.
List<SdkField<?>>	sdkFields()
static Class<? extends Tool.Builder>	serializableBuilderClass()
Boolean	streamOutputToCloudWatch()	Boolean indicating whether logs will be recorded in CloudWatch for the tool.
Boolean	streamUI()	Boolean indicating whether a streaming session will be configured for the tool.
Tool.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

streamUI

public final 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.

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.

name

public final String name()

The name of the tool.

Returns:

The name of the tool.

command

public final String 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

public final Boolean 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

public final 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.

If the service returns an enum value that is not available in the current SDK version, exitBehavior will return ExitBehavior.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from exitBehaviorAsString().

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

exitBehaviorAsString

public final String 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 is RESTART.

If the service returns an enum value that is not available in the current SDK version, exitBehavior will return ExitBehavior.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from exitBehaviorAsString().

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

toBuilder

public Tool.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Tool.Builder,Tool>

builder

public static Tool.Builder builder()

serializableBuilderClass

public static Class<? extends Tool.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo