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. Directory buckets only support EXPRESS_ONEZONE (the S3 Express One Zone storage class) in Availability Zones and ONEZONE_IA (the S3 One Zone-Infrequent Access storage class) in Dedicated Local Zones.

See Also:

  • Method Details

    • 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()
      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<RestoreStatus.Builder,RestoreStatus>
      Returns:
      a builder for type T

    • builder

      public static RestoreStatus.Builder builder()

    • serializableBuilderClass

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