Class SnapshotTierStatus
- java.lang.Object
-
- software.amazon.awssdk.services.ec2.model.SnapshotTierStatus
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<SnapshotTierStatus.Builder,SnapshotTierStatus>
@Generated("software.amazon.awssdk:codegen") public final class SnapshotTierStatus extends Object implements SdkPojo, Serializable, ToCopyableBuilder<SnapshotTierStatus.Builder,SnapshotTierStatus>
Provides information about a snapshot's storage tier.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
SnapshotTierStatus.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Instant
archivalCompleteTime()
The date and time when the last archive process was completed.static SnapshotTierStatus.Builder
builder()
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.TieringOperationStatus
lastTieringOperationStatus()
The status of the last archive or restore process.String
lastTieringOperationStatusAsString()
The status of the last archive or restore process.String
lastTieringOperationStatusDetail()
A message describing the status of the last archive or restore process.Integer
lastTieringProgress()
The progress of the last archive or restore process, as a percentage.Instant
lastTieringStartTime()
The date and time when the last archive or restore process was started.String
ownerId()
The ID of the Amazon Web Services account that owns the snapshot.Instant
restoreExpiryTime()
Only for archived snapshots that are temporarily restored.List<SdkField<?>>
sdkFields()
static Class<? extends SnapshotTierStatus.Builder>
serializableBuilderClass()
String
snapshotId()
The ID of the snapshot.SnapshotState
status()
The state of the snapshot.String
statusAsString()
The state of the snapshot.StorageTier
storageTier()
The storage tier in which the snapshot is stored.String
storageTierAsString()
The storage tier in which the snapshot is stored.List<Tag>
tags()
The tags that are assigned to the snapshot.SnapshotTierStatus.Builder
toBuilder()
String
toString()
Returns a string representation of this object.String
volumeId()
The ID of the volume from which the snapshot was created.-
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
-
snapshotId
public final String snapshotId()
The ID of the snapshot.
- Returns:
- The ID of the snapshot.
-
volumeId
public final String volumeId()
The ID of the volume from which the snapshot was created.
- Returns:
- The ID of the volume from which the snapshot was created.
-
status
public final SnapshotState status()
The state of the snapshot.
If the service returns an enum value that is not available in the current SDK version,
status
will returnSnapshotState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The state of the snapshot.
- See Also:
SnapshotState
-
statusAsString
public final String statusAsString()
The state of the snapshot.
If the service returns an enum value that is not available in the current SDK version,
status
will returnSnapshotState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The state of the snapshot.
- See Also:
SnapshotState
-
ownerId
public final String ownerId()
The ID of the Amazon Web Services account that owns the snapshot.
- Returns:
- The ID of the Amazon Web Services account that owns the snapshot.
-
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 that are assigned to the snapshot.
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 that are assigned to the snapshot.
-
storageTier
public final StorageTier storageTier()
The storage tier in which the snapshot is stored.
standard
indicates that the snapshot is stored in the standard snapshot storage tier and that it is ready for use.archive
indicates that the snapshot is currently archived and that it must be restored before it can be used.If the service returns an enum value that is not available in the current SDK version,
storageTier
will returnStorageTier.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstorageTierAsString()
.- Returns:
- The storage tier in which the snapshot is stored.
standard
indicates that the snapshot is stored in the standard snapshot storage tier and that it is ready for use.archive
indicates that the snapshot is currently archived and that it must be restored before it can be used. - See Also:
StorageTier
-
storageTierAsString
public final String storageTierAsString()
The storage tier in which the snapshot is stored.
standard
indicates that the snapshot is stored in the standard snapshot storage tier and that it is ready for use.archive
indicates that the snapshot is currently archived and that it must be restored before it can be used.If the service returns an enum value that is not available in the current SDK version,
storageTier
will returnStorageTier.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstorageTierAsString()
.- Returns:
- The storage tier in which the snapshot is stored.
standard
indicates that the snapshot is stored in the standard snapshot storage tier and that it is ready for use.archive
indicates that the snapshot is currently archived and that it must be restored before it can be used. - See Also:
StorageTier
-
lastTieringStartTime
public final Instant lastTieringStartTime()
The date and time when the last archive or restore process was started.
- Returns:
- The date and time when the last archive or restore process was started.
-
lastTieringProgress
public final Integer lastTieringProgress()
The progress of the last archive or restore process, as a percentage.
- Returns:
- The progress of the last archive or restore process, as a percentage.
-
lastTieringOperationStatus
public final TieringOperationStatus lastTieringOperationStatus()
The status of the last archive or restore process.
If the service returns an enum value that is not available in the current SDK version,
lastTieringOperationStatus
will returnTieringOperationStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromlastTieringOperationStatusAsString()
.- Returns:
- The status of the last archive or restore process.
- See Also:
TieringOperationStatus
-
lastTieringOperationStatusAsString
public final String lastTieringOperationStatusAsString()
The status of the last archive or restore process.
If the service returns an enum value that is not available in the current SDK version,
lastTieringOperationStatus
will returnTieringOperationStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromlastTieringOperationStatusAsString()
.- Returns:
- The status of the last archive or restore process.
- See Also:
TieringOperationStatus
-
lastTieringOperationStatusDetail
public final String lastTieringOperationStatusDetail()
A message describing the status of the last archive or restore process.
- Returns:
- A message describing the status of the last archive or restore process.
-
archivalCompleteTime
public final Instant archivalCompleteTime()
The date and time when the last archive process was completed.
- Returns:
- The date and time when the last archive process was completed.
-
restoreExpiryTime
public final Instant restoreExpiryTime()
Only for archived snapshots that are temporarily restored. Indicates the date and time when a temporarily restored snapshot will be automatically re-archived.
- Returns:
- Only for archived snapshots that are temporarily restored. Indicates the date and time when a temporarily restored snapshot will be automatically re-archived.
-
toBuilder
public SnapshotTierStatus.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<SnapshotTierStatus.Builder,SnapshotTierStatus>
-
builder
public static SnapshotTierStatus.Builder builder()
-
serializableBuilderClass
public static Class<? extends SnapshotTierStatus.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.
-
-