Class RecordExpiration

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

The journal table record expiration settings for a journal table in an S3 Metadata configuration.

See Also:

  • Method Details

    • expiration

      public final ExpirationState expiration()

      Specifies whether journal table record expiration is enabled or disabled.

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

      Returns:
      Specifies whether journal table record expiration is enabled or disabled.
      See Also:

    • expirationAsString

      public final String expirationAsString()

      Specifies whether journal table record expiration is enabled or disabled.

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

      Returns:
      Specifies whether journal table record expiration is enabled or disabled.
      See Also:

    • days

      public final Integer days()

      If you enable journal table record expiration, you can set the number of days to retain your journal table records. Journal table records must be retained for a minimum of 7 days. To set this value, specify any whole number from 7 to 2147483647. For example, to retain your journal table records for one year, set this value to 365.

      Returns:
      If you enable journal table record expiration, you can set the number of days to retain your journal table records. Journal table records must be retained for a minimum of 7 days. To set this value, specify any whole number from 7 to 2147483647. For example, to retain your journal table records for one year, set this value to 365.

    • toBuilder

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

    • builder

      public static RecordExpiration.Builder builder()

    • serializableBuilderClass

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