Package software.amazon.awssdk.services.fsx.model

Interface SnaplockRetentionPeriod.Builder

All Superinterfaces:
Buildable, CopyableBuilder<SnaplockRetentionPeriod.Builder,SnaplockRetentionPeriod>, SdkBuilder<SnaplockRetentionPeriod.Builder,SnaplockRetentionPeriod>, SdkPojo
Enclosing class:
SnaplockRetentionPeriod
public static interface SnaplockRetentionPeriod.Builder extends SdkPojo, CopyableBuilder<SnaplockRetentionPeriod.Builder,SnaplockRetentionPeriod>

  • Method Details

    • defaultRetention

      SnaplockRetentionPeriod.Builder defaultRetention(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • defaultRetention

      default SnaplockRetentionPeriod.Builder defaultRetention(Consumer<RetentionPeriod.Builder> 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.

      This is a convenience method that creates an instance of the RetentionPeriod.Builder avoiding the need to create one manually via RetentionPeriod.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to defaultRetention(RetentionPeriod).

      Parameters:
      defaultRetention - a consumer that will call methods on RetentionPeriod.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • minimumRetention

      SnaplockRetentionPeriod.Builder minimumRetention(RetentionPeriod minimumRetention)

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

      Parameters:
      minimumRetention - The shortest retention period that can be assigned to a WORM file on an FSx for ONTAP SnapLock volume.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • minimumRetention

      default SnaplockRetentionPeriod.Builder minimumRetention(Consumer<RetentionPeriod.Builder> minimumRetention)

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

      This is a convenience method that creates an instance of the RetentionPeriod.Builder avoiding the need to create one manually via RetentionPeriod.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to minimumRetention(RetentionPeriod).

      Parameters:
      minimumRetention - a consumer that will call methods on RetentionPeriod.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • maximumRetention

      SnaplockRetentionPeriod.Builder maximumRetention(RetentionPeriod maximumRetention)

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

      Parameters:
      maximumRetention - The longest retention period that can be assigned to a WORM file on an FSx for ONTAP SnapLock volume.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maximumRetention

      default SnaplockRetentionPeriod.Builder maximumRetention(Consumer<RetentionPeriod.Builder> maximumRetention)

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

      This is a convenience method that creates an instance of the RetentionPeriod.Builder avoiding the need to create one manually via RetentionPeriod.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to maximumRetention(RetentionPeriod).

      Parameters:
      maximumRetention - a consumer that will call methods on RetentionPeriod.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: