Class RestoreStatus
- java.lang.Object
-
- software.amazon.awssdk.services.s3.model.RestoreStatus
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<RestoreStatus.Builder,RestoreStatus>
@Generated("software.amazon.awssdk:codegen") public final class RestoreStatus extends Object implements SdkPojo, Serializable, ToCopyableBuilder<RestoreStatus.Builder,RestoreStatus>
Specifies the restoration status of an object. Objects in certain storage classes must be restored before they can be retrieved. For more information about these storage classes and how to work with archived objects, see Working with archived objects in the Amazon S3 User Guide.
This functionality is not supported for directory buckets. Only the S3 Express One Zone storage class is supported by directory buckets to store objects.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
RestoreStatus.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static RestoreStatus.Builder
builder()
boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
Boolean
isRestoreInProgress()
Specifies whether the object is currently being restored.Instant
restoreExpiryDate()
Indicates when the restored copy will expire.List<SdkField<?>>
sdkFields()
static Class<? extends RestoreStatus.Builder>
serializableBuilderClass()
RestoreStatus.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
-
isRestoreInProgress
public final Boolean isRestoreInProgress()
Specifies whether the object is currently being restored. If the object restoration is in progress, the header returns the value
TRUE
. For example:x-amz-optional-object-attributes: IsRestoreInProgress="true"
If the object restoration has completed, the header returns the value
FALSE
. For example:x-amz-optional-object-attributes: IsRestoreInProgress="false", RestoreExpiryDate="2012-12-21T00:00:00.000Z"
If the object hasn't been restored, there is no header response.
- Returns:
- Specifies whether the object is currently being restored. If the object restoration is in progress, the
header returns the value
TRUE
. For example:x-amz-optional-object-attributes: IsRestoreInProgress="true"
If the object restoration has completed, the header returns the value
FALSE
. For example:x-amz-optional-object-attributes: IsRestoreInProgress="false", RestoreExpiryDate="2012-12-21T00:00:00.000Z"
If the object hasn't been restored, there is no header response.
-
restoreExpiryDate
public final Instant restoreExpiryDate()
Indicates when the restored copy will expire. This value is populated only if the object has already been restored. For example:
x-amz-optional-object-attributes: IsRestoreInProgress="false", RestoreExpiryDate="2012-12-21T00:00:00.000Z"
- Returns:
- Indicates when the restored copy will expire. This value is populated only if the object has already been
restored. For example:
x-amz-optional-object-attributes: IsRestoreInProgress="false", RestoreExpiryDate="2012-12-21T00:00:00.000Z"
-
toBuilder
public RestoreStatus.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<RestoreStatus.Builder,RestoreStatus>
-
builder
public static RestoreStatus.Builder builder()
-
serializableBuilderClass
public static Class<? extends RestoreStatus.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.
-
-