Class GetRuleResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<GetRuleResponse.Builder,
GetRuleResponse>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic GetRuleResponse.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) Used to retrieve the value of a field from any class that extendsSdkResponse
.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the ResourceTags property.final String
The unique ID of the retention rule.final LockConfiguration
Information about the retention rule lock configuration.final Instant
The date and time at which the unlock delay is set to expire.final LockState
The lock state for the retention rule.final String
The lock state for the retention rule.final List
<ResourceTag> Information about the resource tags used to identify resources that are retained by the retention rule.final ResourceType
The resource type retained by the retention rule.final String
The resource type retained by 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 GetRuleResponse.Builder> final RuleStatus
status()
The state of the retention rule.final String
The state of the retention rule.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 class software.amazon.awssdk.services.rbin.model.RbinResponse
responseMetadata
Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse
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.
-
resourceType
The resource type retained by the retention rule.
If the service returns an enum value that is not available in the current SDK version,
resourceType
will returnResourceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromresourceTypeAsString()
.- Returns:
- The resource type retained by the retention rule.
- See Also:
-
resourceTypeAsString
The resource type retained by the retention rule.
If the service returns an enum value that is not available in the current SDK version,
resourceType
will returnResourceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromresourceTypeAsString()
.- Returns:
- The resource type retained by the retention rule.
- See Also:
-
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.
-
hasResourceTags
public final boolean hasResourceTags()For responses, this returns true if the service returned a value for the ResourceTags property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
resourceTags
Information about the resource tags used to identify resources that are retained by the retention rule.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasResourceTags()
method.- Returns:
- Information about the resource tags used to identify resources that are retained by the retention rule.
-
status
The state of the retention rule. Only retention rules that are in the
available
state retain resources.If the service returns an enum value that is not available in the current SDK version,
status
will returnRuleStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The state of the retention rule. Only retention rules that are in the
available
state retain resources. - See Also:
-
statusAsString
The state of the retention rule. Only retention rules that are in the
available
state retain resources.If the service returns an enum value that is not available in the current SDK version,
status
will returnRuleStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The state of the retention rule. Only retention rules that are in the
available
state retain resources. - See Also:
-
lockConfiguration
Information about the retention rule lock configuration.
- Returns:
- Information about the retention rule lock configuration.
-
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:
-
-
lockEndTime
The date and time at which the unlock delay is set to expire. Only returned for retention rules that have been unlocked and that are still within the unlock delay period.
- Returns:
- The date and time at which the unlock delay is set to expire. Only returned for retention rules that have been unlocked and that are still within the unlock delay period.
-
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<GetRuleResponse.Builder,
GetRuleResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
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
Description copied from class:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-