Package software.amazon.awssdk.services.rbin.model

Class RuleSummary

java.lang.Object

software.amazon.awssdk.services.rbin.model.RuleSummary

All Implemented Interfaces:

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

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

Information about a Recycle Bin retention rule.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RuleSummary.Builder

Method Summary

Modifier and Type	Method	Description
static RuleSummary.Builder	builder()
String	description()	The retention rule description.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	identifier()	The unique ID of the retention rule.
LockState	lockState()	The lock state for the retention rule.
String	lockStateAsString()	The lock state for the retention rule.
RetentionPeriod	retentionPeriod()	Information about the retention period for which the retention rule is to retain resources.
List<SdkField<?>>	sdkFields()
static Class<? extends RuleSummary.Builder>	serializableBuilderClass()
RuleSummary.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

identifier

public final String identifier()

The unique ID of the retention rule.

Returns:

The unique ID of the retention rule.

description

public final String description()

The retention rule description.

Returns:

The retention rule description.

retentionPeriod

public final RetentionPeriod retentionPeriod()

Information about the retention period for which the retention rule is to retain resources.

Returns:

Information about the retention period for which the retention rule is to retain resources.

lockState

public final LockState lockState()

The lock state for the retention rule.

• locked - The retention rule is locked and can't be modified or deleted.

• pending_unlock - The retention rule has been unlocked but it is still within the unlock delay period. The retention rule can be modified or deleted only after the unlock delay period has expired.

• unlocked - The retention rule is unlocked and it can be modified or deleted by any user with the required permissions.

• null - The retention rule has never been locked. Once a retention rule has been locked, it can transition between the locked and unlocked states only; it can never transition back to null.

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

Returns:

The lock state for the retention rule.

• locked - The retention rule is locked and can't be modified or deleted.

• pending_unlock - The retention rule has been unlocked but it is still within the unlock delay period. The retention rule can be modified or deleted only after the unlock delay period has expired.

• unlocked - The retention rule is unlocked and it can be modified or deleted by any user with the required permissions.

• null - The retention rule has never been locked. Once a retention rule has been locked, it can transition between the locked and unlocked states only; it can never transition back to null.

See Also:

LockState

lockStateAsString

public final String lockStateAsString()

The lock state for the retention rule.

• locked - The retention rule is locked and can't be modified or deleted.

• pending_unlock - The retention rule has been unlocked but it is still within the unlock delay period. The retention rule can be modified or deleted only after the unlock delay period has expired.

• unlocked - The retention rule is unlocked and it can be modified or deleted by any user with the required permissions.

• null - The retention rule has never been locked. Once a retention rule has been locked, it can transition between the locked and unlocked states only; it can never transition back to null.

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

Returns:

The lock state for the retention rule.

• locked - The retention rule is locked and can't be modified or deleted.

• pending_unlock - The retention rule has been unlocked but it is still within the unlock delay period. The retention rule can be modified or deleted only after the unlock delay period has expired.

• unlocked - The retention rule is unlocked and it can be modified or deleted by any user with the required permissions.

• null - The retention rule has never been locked. Once a retention rule has been locked, it can transition between the locked and unlocked states only; it can never transition back to null.

See Also:

LockState

toBuilder

public RuleSummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RuleSummary.Builder,RuleSummary>

builder

public static RuleSummary.Builder builder()

serializableBuilderClass

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