Class ProgressDetail

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

Information about the progress of a deployment job.

See Also:

  • Method Details

    • currentProgress

      public final RobotDeploymentStep currentProgress()

      The current progress status.

      Validating

      Validating the deployment.

      DownloadingExtracting

      Downloading and extracting the bundle on the robot.

      ExecutingPreLaunch

      Executing pre-launch script(s) if provided.

      Launching

      Launching the robot application.

      ExecutingPostLaunch

      Executing post-launch script(s) if provided.

      Finished

      Deployment is complete.

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

      Returns:
      The current progress status.

      Validating

      Validating the deployment.

      DownloadingExtracting

      Downloading and extracting the bundle on the robot.

      ExecutingPreLaunch

      Executing pre-launch script(s) if provided.

      Launching

      Launching the robot application.

      ExecutingPostLaunch

      Executing post-launch script(s) if provided.

      Finished

      Deployment is complete.

      See Also:

    • currentProgressAsString

      public final String currentProgressAsString()

      The current progress status.

      Validating

      Validating the deployment.

      DownloadingExtracting

      Downloading and extracting the bundle on the robot.

      ExecutingPreLaunch

      Executing pre-launch script(s) if provided.

      Launching

      Launching the robot application.

      ExecutingPostLaunch

      Executing post-launch script(s) if provided.

      Finished

      Deployment is complete.

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

      Returns:
      The current progress status.

      Validating

      Validating the deployment.

      DownloadingExtracting

      Downloading and extracting the bundle on the robot.

      ExecutingPreLaunch

      Executing pre-launch script(s) if provided.

      Launching

      Launching the robot application.

      ExecutingPostLaunch

      Executing post-launch script(s) if provided.

      Finished

      Deployment is complete.

      See Also:

    • percentDone

      public final Float percentDone()

      Precentage of the step that is done. This currently only applies to the Downloading/Extracting step of the deployment. It is empty for other steps.

      Returns:
      Precentage of the step that is done. This currently only applies to the Downloading/Extracting step of the deployment. It is empty for other steps.

    • estimatedTimeRemainingSeconds

      public final Integer estimatedTimeRemainingSeconds()

      Estimated amount of time in seconds remaining in the step. This currently only applies to the Downloading/Extracting step of the deployment. It is empty for other steps.

      Returns:
      Estimated amount of time in seconds remaining in the step. This currently only applies to the Downloading/Extracting step of the deployment. It is empty for other steps.

    • targetResource

      public final String targetResource()

      The Amazon Resource Name (ARN) of the deployment job.

      Returns:
      The Amazon Resource Name (ARN) of the deployment job.

    • toBuilder

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

    • builder

      public static ProgressDetail.Builder builder()

    • serializableBuilderClass

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