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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
ReplaceRootVolumeTask.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ReplaceRootVolumeTask.Builder
builder()
String
completeTime()
The time the task completed.Boolean
deleteReplacedRootVolume()
Indicates whether the original root volume is to be deleted after the root volume replacement task completes.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.String
imageId()
The ID of the AMI used to create the replacement root volume.String
instanceId()
The ID of the instance for which the root volume replacement task was created.String
replaceRootVolumeTaskId()
The ID of the root volume replacement task.List<SdkField<?>>
sdkFields()
static Class<? extends ReplaceRootVolumeTask.Builder>
serializableBuilderClass()
String
snapshotId()
The ID of the snapshot used to create the replacement root volume.String
startTime()
The time the task was started.List<Tag>
tags()
The tags assigned to the task.ReplaceRootVolumeTaskState
taskState()
The state of the task.String
taskStateAsString()
The state of the task.ReplaceRootVolumeTask.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
-
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 returnReplaceRootVolumeTaskState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtaskStateAsString()
.- 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:
ReplaceRootVolumeTaskState
-
-
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 returnReplaceRootVolumeTaskState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtaskStateAsString()
.- 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:
ReplaceRootVolumeTaskState
-
-
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 theisEmpty()
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()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<ReplaceRootVolumeTask.Builder,ReplaceRootVolumeTask>
-
builder
public static ReplaceRootVolumeTask.Builder builder()
-
serializableBuilderClass
public static Class<? extends ReplaceRootVolumeTask.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
-