Class ReplaceRootVolumeTask
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<ReplaceRootVolumeTask.Builder,
ReplaceRootVolumeTask>
Information about a root volume replacement task.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
The time the task completed.final Boolean
Indicates whether the original root volume is to be deleted after the root volume replacement task completes.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final String
imageId()
The ID of the AMI used to create the replacement root volume.final String
The ID of the instance for which the root volume replacement task was created.final String
The ID of the root volume replacement task.static Class
<? extends ReplaceRootVolumeTask.Builder> final String
The ID of the snapshot used to create the replacement root volume.final String
The time the task was started.tags()
The tags assigned to the task.The state of the task.final String
The state of the task.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
replaceRootVolumeTaskId
The ID of the root volume replacement task.
- Returns:
- The ID of the root volume replacement task.
-
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
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:
-
-
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:
-
-
startTime
The time the task was started.
- Returns:
- The time the task was started.
-
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
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
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
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
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
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 interfaceToCopyableBuilder<ReplaceRootVolumeTask.Builder,
ReplaceRootVolumeTask> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-