Package software.amazon.awssdk.services.dlm.model

Class CrossRegionCopyRetainRule

java.lang.Object

software.amazon.awssdk.services.dlm.model.CrossRegionCopyRetainRule

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<CrossRegionCopyRetainRule.Builder,CrossRegionCopyRetainRule>

@Generated("software.amazon.awssdk:codegen")
public final class CrossRegionCopyRetainRule
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<CrossRegionCopyRetainRule.Builder,CrossRegionCopyRetainRule>

Specifies a retention rule for cross-Region snapshot copies created by snapshot or event-based policies, or cross-Region AMI copies created by AMI policies. After the retention period expires, the cross-Region copy is deleted.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CrossRegionCopyRetainRule.Builder

Method Summary

Modifier and Type	Method	Description
static CrossRegionCopyRetainRule.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	interval()	The amount of time to retain a cross-Region snapshot or AMI copy.
RetentionIntervalUnitValues	intervalUnit()	The unit of time for time-based retention.
String	intervalUnitAsString()	The unit of time for time-based retention.
List<SdkField<?>>	sdkFields()
static Class<? extends CrossRegionCopyRetainRule.Builder>	serializableBuilderClass()
CrossRegionCopyRetainRule.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

interval

public final Integer interval()

The amount of time to retain a cross-Region snapshot or AMI copy. The maximum is 100 years. This is equivalent to 1200 months, 5200 weeks, or 36500 days.

Returns:

The amount of time to retain a cross-Region snapshot or AMI copy. The maximum is 100 years. This is equivalent to 1200 months, 5200 weeks, or 36500 days.

intervalUnit

public final RetentionIntervalUnitValues intervalUnit()

The unit of time for time-based retention. For example, to retain a cross-Region copy for 3 months, specify Interval=3 and IntervalUnit=MONTHS.

If the service returns an enum value that is not available in the current SDK version, intervalUnit will return RetentionIntervalUnitValues.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from intervalUnitAsString().

Returns:

The unit of time for time-based retention. For example, to retain a cross-Region copy for 3 months, specify Interval=3 and IntervalUnit=MONTHS.

See Also:

RetentionIntervalUnitValues

intervalUnitAsString

public final String intervalUnitAsString()

The unit of time for time-based retention. For example, to retain a cross-Region copy for 3 months, specify Interval=3 and IntervalUnit=MONTHS.

If the service returns an enum value that is not available in the current SDK version, intervalUnit will return RetentionIntervalUnitValues.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from intervalUnitAsString().

Returns:

The unit of time for time-based retention. For example, to retain a cross-Region copy for 3 months, specify Interval=3 and IntervalUnit=MONTHS.

See Also:

RetentionIntervalUnitValues

toBuilder

public CrossRegionCopyRetainRule.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CrossRegionCopyRetainRule.Builder,CrossRegionCopyRetainRule>

builder

public static CrossRegionCopyRetainRule.Builder builder()

serializableBuilderClass

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