Class RetentionPeriod

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

Information about the retention period for which the retention rule is to retain resources.

See Also:

  • Method Details

    • retentionPeriodValue

      public final Integer retentionPeriodValue()

      The period value for which the retention rule is to retain resources. The period is measured using the unit specified for RetentionPeriodUnit.

      Returns:
      The period value for which the retention rule is to retain resources. The period is measured using the unit specified for RetentionPeriodUnit.

    • retentionPeriodUnit

      public final RetentionPeriodUnit retentionPeriodUnit()

      The unit of time in which the retention period is measured. Currently, only DAYS is supported.

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

      Returns:
      The unit of time in which the retention period is measured. Currently, only DAYS is supported.
      See Also:

    • retentionPeriodUnitAsString

      public final String retentionPeriodUnitAsString()

      The unit of time in which the retention period is measured. Currently, only DAYS is supported.

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

      Returns:
      The unit of time in which the retention period is measured. Currently, only DAYS is supported.
      See Also:

    • toBuilder

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

    • builder

      public static RetentionPeriod.Builder builder()

    • serializableBuilderClass

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