Class S3SetObjectRetentionOperation

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

Contains the configuration parameters for the Object Lock retention action for an S3 Batch Operations job. Batch Operations passes every object to the underlying PutObjectRetention API operation. For more information, see Using S3 Object Lock retention with S3 Batch Operations in the Amazon S3 User Guide.

This functionality is not supported by directory buckets.

See Also:

  • Method Details

    • bypassGovernanceRetention

      public final Boolean bypassGovernanceRetention()

      Indicates if the action should be applied to objects in the Batch Operations job even if they have Object Lock GOVERNANCE type in place.

      Returns:
      Indicates if the action should be applied to objects in the Batch Operations job even if they have Object Lock GOVERNANCE type in place.

    • retention

      public final S3Retention retention()

      Contains the Object Lock retention mode to be applied to all objects in the Batch Operations job. For more information, see Using S3 Object Lock retention with S3 Batch Operations in the Amazon S3 User Guide.

      Returns:
      Contains the Object Lock retention mode to be applied to all objects in the Batch Operations job. For more information, see Using S3 Object Lock retention with S3 Batch Operations in the Amazon S3 User Guide.

    • toBuilder

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

    • builder

      public static S3SetObjectRetentionOperation.Builder builder()

    • serializableBuilderClass

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