Class RuleSummary
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<RuleSummary.Builder,
RuleSummary>
Information about a Recycle Bin retention rule.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic RuleSummary.Builder
builder()
final String
The retention rule description.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final String
The unique ID of the retention rule.final LockState
The lock state for the retention rule.final String
The lock state for the retention rule.final RetentionPeriod
Information about the retention period for which the retention rule is to retain resources.final String
ruleArn()
The Amazon Resource Name (ARN) of the retention rule.static Class
<? extends RuleSummary.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
identifier
The unique ID of the retention rule.
- Returns:
- The unique ID of the retention rule.
-
description
The retention rule description.
- Returns:
- The retention rule description.
-
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
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 thelocked
andunlocked
states only; it can never transition back tonull
.
If the service returns an enum value that is not available in the current SDK version,
lockState
will returnLockState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromlockStateAsString()
.- 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 thelocked
andunlocked
states only; it can never transition back tonull
.
-
- See Also:
-
-
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 thelocked
andunlocked
states only; it can never transition back tonull
.
If the service returns an enum value that is not available in the current SDK version,
lockState
will returnLockState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromlockStateAsString()
.- 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 thelocked
andunlocked
states only; it can never transition back tonull
.
-
- See Also:
-
-
ruleArn
The Amazon Resource Name (ARN) of the retention rule.
- Returns:
- The Amazon Resource Name (ARN) of the retention rule.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<RuleSummary.Builder,
RuleSummary> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-