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

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SnaplockRetentionPeriod.Builder

Method Summary

Modifier and Type	Method	Description
static SnaplockRetentionPeriod.Builder	builder()
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.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
RetentionPeriod	maximumRetention()	The longest retention period that can be assigned to a WORM file on an FSx for ONTAP SnapLock volume.
RetentionPeriod	minimumRetention()	The shortest retention period that can be assigned to a WORM file on an FSx for ONTAP SnapLock volume.
List<SdkField<?>>	sdkFields()
static Class<? extends SnaplockRetentionPeriod.Builder>	serializableBuilderClass()
SnaplockRetentionPeriod.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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()

Specified by:

toBuilder in interface ToCopyableBuilder<SnaplockRetentionPeriod.Builder,SnaplockRetentionPeriod>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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