Class S3Retention

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

Contains the S3 Object Lock retention mode to be applied to all objects in the S3 Batch Operations job. If you don't provide Mode and RetainUntilDate data types in your operation, you will remove the retention from your objects. For more information, see Using S3 Object Lock retention with S3 Batch Operations in the Amazon S3 User Guide.

See Also:

  • Method Details

    • retainUntilDate

      public final Instant retainUntilDate()

      The date when the applied Object Lock retention will expire on all objects set by the Batch Operations job.

      Returns:
      The date when the applied Object Lock retention will expire on all objects set by the Batch Operations job.

    • mode

      public final S3ObjectLockRetentionMode mode()

      The Object Lock retention mode to be applied to all objects in the Batch Operations job.

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

      Returns:
      The Object Lock retention mode to be applied to all objects in the Batch Operations job.
      See Also:

    • modeAsString

      public final String modeAsString()

      The Object Lock retention mode to be applied to all objects in the Batch Operations job.

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

      Returns:
      The Object Lock retention mode to be applied to all objects in the Batch Operations job.
      See Also:

    • toBuilder

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

    • builder

      public static S3Retention.Builder builder()

    • serializableBuilderClass

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