Class ReplaceRootVolumeTask

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

Information about a root volume replacement task.

See Also:

  • Method Details

    • replaceRootVolumeTaskId

      public final String replaceRootVolumeTaskId()

      The ID of the root volume replacement task.

      Returns:
      The ID of the root volume replacement task.

    • instanceId

      public final String instanceId()

      The ID of the instance for which the root volume replacement task was created.

      Returns:
      The ID of the instance for which the root volume replacement task was created.

    • taskState

      public final ReplaceRootVolumeTaskState taskState()

      The state of the task. The task can be in one of the following states:

      • pending - the replacement volume is being created.

      • in-progress - the original volume is being detached and the replacement volume is being attached.

      • succeeded - the replacement volume has been successfully attached to the instance and the instance is available.

      • failing - the replacement task is in the process of failing.

      • failed - the replacement task has failed but the original root volume is still attached.

      • failing-detached - the replacement task is in the process of failing. The instance might have no root volume attached.

      • failed-detached - the replacement task has failed and the instance has no root volume attached.

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

      Returns:
      The state of the task. The task can be in one of the following states:

      • pending - the replacement volume is being created.

      • in-progress - the original volume is being detached and the replacement volume is being attached.

      • succeeded - the replacement volume has been successfully attached to the instance and the instance is available.

      • failing - the replacement task is in the process of failing.

      • failed - the replacement task has failed but the original root volume is still attached.

      • failing-detached - the replacement task is in the process of failing. The instance might have no root volume attached.

      • failed-detached - the replacement task has failed and the instance has no root volume attached.

      See Also:

    • taskStateAsString

      public final String taskStateAsString()

      The state of the task. The task can be in one of the following states:

      • pending - the replacement volume is being created.

      • in-progress - the original volume is being detached and the replacement volume is being attached.

      • succeeded - the replacement volume has been successfully attached to the instance and the instance is available.

      • failing - the replacement task is in the process of failing.

      • failed - the replacement task has failed but the original root volume is still attached.

      • failing-detached - the replacement task is in the process of failing. The instance might have no root volume attached.

      • failed-detached - the replacement task has failed and the instance has no root volume attached.

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

      Returns:
      The state of the task. The task can be in one of the following states:

      • pending - the replacement volume is being created.

      • in-progress - the original volume is being detached and the replacement volume is being attached.

      • succeeded - the replacement volume has been successfully attached to the instance and the instance is available.

      • failing - the replacement task is in the process of failing.

      • failed - the replacement task has failed but the original root volume is still attached.

      • failing-detached - the replacement task is in the process of failing. The instance might have no root volume attached.

      • failed-detached - the replacement task has failed and the instance has no root volume attached.

      See Also:

    • startTime

      public final String startTime()

      The time the task was started.

      Returns:
      The time the task was started.

    • completeTime

      public final String completeTime()

      The time the task completed.

      Returns:
      The time the task completed.

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • tags

      public final List<Tag> tags()

      The tags assigned to the task.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

      Returns:
      The tags assigned to the task.

    • imageId

      public final String imageId()

      The ID of the AMI used to create the replacement root volume.

      Returns:
      The ID of the AMI used to create the replacement root volume.

    • snapshotId

      public final String snapshotId()

      The ID of the snapshot used to create the replacement root volume.

      Returns:
      The ID of the snapshot used to create the replacement root volume.

    • deleteReplacedRootVolume

      public final Boolean deleteReplacedRootVolume()

      Indicates whether the original root volume is to be deleted after the root volume replacement task completes.

      Returns:
      Indicates whether the original root volume is to be deleted after the root volume replacement task completes.

    • toBuilder

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

    • builder

      public static ReplaceRootVolumeTask.Builder builder()

    • serializableBuilderClass

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