Class S3SetObjectLegalHoldOperation

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

Contains the configuration for an S3 Object Lock legal hold operation that an S3 Batch Operations job passes to every object to the underlying PutObjectLegalHold API operation. For more information, see Using S3 Object Lock legal hold with S3 Batch Operations in the Amazon S3 User Guide.

This functionality is not supported by directory buckets.

See Also:

  • Method Details

    • legalHold

      public final S3ObjectLockLegalHold legalHold()

      Contains the Object Lock legal hold status to be applied to all objects in the Batch Operations job.

      Returns:
      Contains the Object Lock legal hold status to be applied to all objects in the Batch Operations job.

    • toBuilder

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

    • builder

      public static S3SetObjectLegalHoldOperation.Builder builder()

    • serializableBuilderClass

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