Package software.amazon.awssdk.services.s3control.model

Class S3ObjectLockLegalHold

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

Whether S3 Object Lock legal hold will be applied to objects in an S3 Batch Operations job.

See Also:

  • Method Details

    • status

      public final S3ObjectLockLegalHoldStatus status()

      The Object Lock legal hold status 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, status will return S3ObjectLockLegalHoldStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

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

    • statusAsString

      public final String statusAsString()

      The Object Lock legal hold status 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, status will return S3ObjectLockLegalHoldStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

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

    • toBuilder

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

    • builder

      public static S3ObjectLockLegalHold.Builder builder()

    • serializableBuilderClass

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