com.amazonaws.services.fsx.model

Class SnaplockRetentionPeriod

java.lang.Object

com.amazonaws.services.fsx.model.SnaplockRetentionPeriod

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class SnaplockRetentionPeriod
extends Object
implements Serializable, Cloneable, StructuredPojo

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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
SnaplockRetentionPeriod()

Method Summary

Modifier and Type	Method and Description
SnaplockRetentionPeriod	clone()
boolean	equals(Object obj)
RetentionPeriod	getDefaultRetention() 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.
RetentionPeriod	getMaximumRetention() The longest retention period that can be assigned to a WORM file on an FSx for ONTAP SnapLock volume.
RetentionPeriod	getMinimumRetention() The shortest retention period that can be assigned to a WORM file on an FSx for ONTAP SnapLock volume.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setDefaultRetention(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.
void	setMaximumRetention(RetentionPeriod maximumRetention) The longest retention period that can be assigned to a WORM file on an FSx for ONTAP SnapLock volume.
void	setMinimumRetention(RetentionPeriod minimumRetention) The shortest retention period that can be assigned to a WORM file on an FSx for ONTAP SnapLock volume.
String	toString() Returns a string representation of this object.
SnaplockRetentionPeriod	withDefaultRetention(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.
SnaplockRetentionPeriod	withMaximumRetention(RetentionPeriod maximumRetention) The longest retention period that can be assigned to a WORM file on an FSx for ONTAP SnapLock volume.
SnaplockRetentionPeriod	withMinimumRetention(RetentionPeriod minimumRetention) The shortest retention period that can be assigned to a WORM file on an FSx for ONTAP SnapLock volume.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SnaplockRetentionPeriod

public SnaplockRetentionPeriod()

Method Detail

setDefaultRetention

public void setDefaultRetention(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.

getDefaultRetention

public RetentionPeriod getDefaultRetention()

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.

withDefaultRetention

public SnaplockRetentionPeriod withDefaultRetention(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.

setMinimumRetention

public void setMinimumRetention(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.

getMinimumRetention

public RetentionPeriod getMinimumRetention()

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.

withMinimumRetention

public SnaplockRetentionPeriod withMinimumRetention(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.

setMaximumRetention

public void setMaximumRetention(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.

getMaximumRetention

public RetentionPeriod getMaximumRetention()

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.

withMaximumRetention

public SnaplockRetentionPeriod withMaximumRetention(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.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public SnaplockRetentionPeriod clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.