Class SnaplockRetentionPeriod

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

The configuration to set the retention period of an FSx for ONTAP SnapLock volume. The retention period includes default, maximum, and minimum settings. For more information, see Working with the retention period in SnapLock.

See Also:

  • Method Details

    • defaultRetention

      public final RetentionPeriod defaultRetention()

      The retention period assigned to a write once, read many (WORM) file by default if an explicit retention period is not set for an FSx for ONTAP SnapLock volume. The default retention period must be greater than or equal to the minimum retention period and less than or equal to the maximum retention period.

      Returns:
      The retention period assigned to a write once, read many (WORM) file by default if an explicit retention period is not set for an FSx for ONTAP SnapLock volume. The default retention period must be greater than or equal to the minimum retention period and less than or equal to the maximum retention period.

    • minimumRetention

      public final RetentionPeriod minimumRetention()

      The shortest retention period that can be assigned to a WORM file on an FSx for ONTAP SnapLock volume.

      Returns:
      The shortest retention period that can be assigned to a WORM file on an FSx for ONTAP SnapLock volume.

    • maximumRetention

      public final RetentionPeriod maximumRetention()

      The longest retention period that can be assigned to a WORM file on an FSx for ONTAP SnapLock volume.

      Returns:
      The longest retention period that can be assigned to a WORM file on an FSx for ONTAP SnapLock volume.

    • toBuilder

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

    • builder

      public static SnaplockRetentionPeriod.Builder builder()

    • serializableBuilderClass

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