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:

  • Method Details

    • 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:

    • 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:

    • toBuilder

      public Tool.Builder 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 interface ToCopyableBuilder<Tool.Builder,Tool>
      Returns:
      a builder for type T

    • 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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.