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

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RetentionPeriod.Builder

Method Summary

Modifier and Type	Method	Description
static RetentionPeriod.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends RetentionPeriod.Builder>	serializableBuilderClass()
RetentionPeriod.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
RetentionPeriodType	type()	Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume.
String	typeAsString()	Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume.
Integer	value()	Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume.

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

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:

RetentionPeriodType

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:

RetentionPeriodType

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

Specified by:

toBuilder in interface ToCopyableBuilder<RetentionPeriod.Builder,RetentionPeriod>

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)

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo