Class RobotDeployment

java.lang.Object
software.amazon.awssdk.services.robomaker.model.RobotDeployment
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<RobotDeployment.Builder,RobotDeployment>
@Generated("software.amazon.awssdk:codegen") public final class RobotDeployment extends Object implements SdkPojo, Serializable, ToCopyableBuilder<RobotDeployment.Builder,RobotDeployment>

Information about a robot deployment.

See Also:

  • Method Details

    • arn

      public final String arn()

      The robot deployment Amazon Resource Name (ARN).

      Returns:
      The robot deployment Amazon Resource Name (ARN).

    • deploymentStartTime

      public final Instant deploymentStartTime()

      The time, in milliseconds since the epoch, when the deployment was started.

      Returns:
      The time, in milliseconds since the epoch, when the deployment was started.

    • deploymentFinishTime

      public final Instant deploymentFinishTime()

      The time, in milliseconds since the epoch, when the deployment finished.

      Returns:
      The time, in milliseconds since the epoch, when the deployment finished.

    • status

      public final RobotStatus status()

      The status of the robot deployment.

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

      Returns:
      The status of the robot deployment.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the robot deployment.

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

      Returns:
      The status of the robot deployment.
      See Also:

    • progressDetail

      public final ProgressDetail progressDetail()

      Information about how the deployment is progressing.

      Returns:
      Information about how the deployment is progressing.

    • failureReason

      public final String failureReason()

      A short description of the reason why the robot deployment failed.

      Returns:
      A short description of the reason why the robot deployment failed.

    • failureCode

      public final DeploymentJobErrorCode failureCode()

      The robot deployment failure code.

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

      Returns:
      The robot deployment failure code.
      See Also:

    • failureCodeAsString

      public final String failureCodeAsString()

      The robot deployment failure code.

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

      Returns:
      The robot deployment failure code.
      See Also:

    • toBuilder

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

    • builder

      public static RobotDeployment.Builder builder()

    • serializableBuilderClass

      public static Class<? extends RobotDeployment.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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.