Class ObjectLockRetention

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

A Retention configuration for an object.

See Also:

  • Method Details

    • mode

      public final ObjectLockRetentionMode mode()

      Indicates the Retention mode for the specified object.

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

      Returns:
      Indicates the Retention mode for the specified object.
      See Also:

    • modeAsString

      public final String modeAsString()

      Indicates the Retention mode for the specified object.

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

      Returns:
      Indicates the Retention mode for the specified object.
      See Also:

    • retainUntilDate

      public final Instant retainUntilDate()

      The date on which this Object Lock Retention will expire.

      Returns:
      The date on which this Object Lock Retention will expire.

    • eventHold

      public final ObjectLockEventHold eventHold()

      The event hold status for the object. Set to ON to enable an event hold or OFF to disable it.

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

      Returns:
      The event hold status for the object. Set to ON to enable an event hold or OFF to disable it.
      See Also:

    • eventHoldAsString

      public final String eventHoldAsString()

      The event hold status for the object. Set to ON to enable an event hold or OFF to disable it.

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

      Returns:
      The event hold status for the object. Set to ON to enable an event hold or OFF to disable it.
      See Also:

    • eventHoldDuration

      public final EventHoldDuration eventHoldDuration()

      The event hold duration for the object. Specifies how long the object remains protected after the event hold is released.

      Returns:
      The event hold duration for the object. Specifies how long the object remains protected after the event hold is released.

    • toBuilder

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

    • builder

      public static ObjectLockRetention.Builder builder()

    • serializableBuilderClass

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