Class NoncurrentVersionExpiration

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

Specifies when noncurrent object versions expire. Upon expiration, Amazon S3 permanently deletes the noncurrent object versions. You set this lifecycle configuration action on a bucket that has versioning enabled (or suspended) to request that Amazon S3 delete noncurrent object versions at a specific period in the object's lifetime.

This parameter applies to general purpose buckets only. It is not supported for directory bucket lifecycle configurations.

See Also:

  • Method Details

    • noncurrentDays

      public final Integer noncurrentDays()

      Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action. The value must be a non-zero positive integer. For information about the noncurrent days calculations, see How Amazon S3 Calculates When an Object Became Noncurrent in the Amazon S3 User Guide.

      This parameter applies to general purpose buckets only. It is not supported for directory bucket lifecycle configurations.

      Returns:
      Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action. The value must be a non-zero positive integer. For information about the noncurrent days calculations, see How Amazon S3 Calculates When an Object Became Noncurrent in the Amazon S3 User Guide.

      This parameter applies to general purpose buckets only. It is not supported for directory bucket lifecycle configurations.

    • newerNoncurrentVersions

      public final Integer newerNoncurrentVersions()

      Specifies how many noncurrent versions Amazon S3 will retain. You can specify up to 100 noncurrent versions to retain. Amazon S3 will permanently delete any additional noncurrent versions beyond the specified number to retain. For more information about noncurrent versions, see Lifecycle configuration elements in the Amazon S3 User Guide.

      This parameter applies to general purpose buckets only. It is not supported for directory bucket lifecycle configurations.

      Returns:
      Specifies how many noncurrent versions Amazon S3 will retain. You can specify up to 100 noncurrent versions to retain. Amazon S3 will permanently delete any additional noncurrent versions beyond the specified number to retain. For more information about noncurrent versions, see Lifecycle configuration elements in the Amazon S3 User Guide.

      This parameter applies to general purpose buckets only. It is not supported for directory bucket lifecycle configurations.

    • toBuilder

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

    • builder

      public static NoncurrentVersionExpiration.Builder builder()

    • serializableBuilderClass

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