Class RetentionPeriod

java.lang.Object
software.amazon.awssdk.services.fsx.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>

Specifies the retention period of an FSx for ONTAP SnapLock volume. After it is set, it can't be changed. Files can't be deleted or modified during the retention period.

For more information, see Working with the retention period in SnapLock.

See Also:

  • Method Details

    • type

      public final RetentionPeriodType type()

      Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to INFINITE, the files are retained forever. If you set it to UNSPECIFIED, the files are retained until you set an explicit retention period.

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

      Returns:
      Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to INFINITE, the files are retained forever. If you set it to UNSPECIFIED, the files are retained until you set an explicit retention period.
      See Also:

    • typeAsString

      public final String typeAsString()

      Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to INFINITE, the files are retained forever. If you set it to UNSPECIFIED, the files are retained until you set an explicit retention period.

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

      Returns:
      Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to INFINITE, the files are retained forever. If you set it to UNSPECIFIED, the files are retained until you set an explicit retention period.
      See Also:

    • value

      public final Integer value()

      Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can't set a value for INFINITE or UNSPECIFIED. For all other options, the following ranges are valid:

      • Seconds: 0 - 65,535

      • Minutes: 0 - 65,535

      • Hours: 0 - 24

      • Days: 0 - 365

      • Months: 0 - 12

      • Years: 0 - 100

      Returns:
      Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can't set a value for INFINITE or UNSPECIFIED. For all other options, the following ranges are valid:

      • Seconds: 0 - 65,535

      • Minutes: 0 - 65,535

      • Hours: 0 - 24

      • Days: 0 - 365

      • Months: 0 - 12

      • Years: 0 - 100

    • 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.