Class S3InitiateRestoreObjectOperation

java.lang.Object
software.amazon.awssdk.services.s3control.model.S3InitiateRestoreObjectOperation
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<S3InitiateRestoreObjectOperation.Builder,S3InitiateRestoreObjectOperation>
@Generated("software.amazon.awssdk:codegen") public final class S3InitiateRestoreObjectOperation extends Object implements SdkPojo, Serializable, ToCopyableBuilder<S3InitiateRestoreObjectOperation.Builder,S3InitiateRestoreObjectOperation>

Contains the configuration parameters for a POST Object restore job. S3 Batch Operations passes every object to the underlying RestoreObject API operation. For more information about the parameters for this operation, see RestoreObject.

See Also:

  • Method Details

    • expirationInDays

      public final Integer expirationInDays()

      This argument specifies how long the S3 Glacier or S3 Glacier Deep Archive object remains available in Amazon S3. S3 Initiate Restore Object jobs that target S3 Glacier and S3 Glacier Deep Archive objects require ExpirationInDays set to 1 or greater.

      Conversely, do not set ExpirationInDays when creating S3 Initiate Restore Object jobs that target S3 Intelligent-Tiering Archive Access and Deep Archive Access tier objects. Objects in S3 Intelligent-Tiering archive access tiers are not subject to restore expiry, so specifying ExpirationInDays results in restore request failure.

      S3 Batch Operations jobs can operate either on S3 Glacier and S3 Glacier Deep Archive storage class objects or on S3 Intelligent-Tiering Archive Access and Deep Archive Access storage tier objects, but not both types in the same job. If you need to restore objects of both types you must create separate Batch Operations jobs.

      Returns:
      This argument specifies how long the S3 Glacier or S3 Glacier Deep Archive object remains available in Amazon S3. S3 Initiate Restore Object jobs that target S3 Glacier and S3 Glacier Deep Archive objects require ExpirationInDays set to 1 or greater.

      Conversely, do not set ExpirationInDays when creating S3 Initiate Restore Object jobs that target S3 Intelligent-Tiering Archive Access and Deep Archive Access tier objects. Objects in S3 Intelligent-Tiering archive access tiers are not subject to restore expiry, so specifying ExpirationInDays results in restore request failure.

      S3 Batch Operations jobs can operate either on S3 Glacier and S3 Glacier Deep Archive storage class objects or on S3 Intelligent-Tiering Archive Access and Deep Archive Access storage tier objects, but not both types in the same job. If you need to restore objects of both types you must create separate Batch Operations jobs.

    • glacierJobTier

      public final S3GlacierJobTier glacierJobTier()

      S3 Batch Operations supports STANDARD and BULK retrieval tiers, but not the EXPEDITED retrieval tier.

      If the service returns an enum value that is not available in the current SDK version, glacierJobTier will return S3GlacierJobTier.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from glacierJobTierAsString().

      Returns:
      S3 Batch Operations supports STANDARD and BULK retrieval tiers, but not the EXPEDITED retrieval tier.
      See Also:

    • glacierJobTierAsString

      public final String glacierJobTierAsString()

      S3 Batch Operations supports STANDARD and BULK retrieval tiers, but not the EXPEDITED retrieval tier.

      If the service returns an enum value that is not available in the current SDK version, glacierJobTier will return S3GlacierJobTier.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from glacierJobTierAsString().

      Returns:
      S3 Batch Operations supports STANDARD and BULK retrieval tiers, but not the EXPEDITED retrieval tier.
      See Also:

    • toBuilder

      public S3InitiateRestoreObjectOperation.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<S3InitiateRestoreObjectOperation.Builder,S3InitiateRestoreObjectOperation>
      Returns:
      a builder for type T

    • builder

      public static S3InitiateRestoreObjectOperation.Builder builder()

    • serializableBuilderClass

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