GetRuleResponse (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.core.SdkResponse
- - software.amazon.awssdk.awscore.AwsResponse
  - - software.amazon.awssdk.services.rbin.model.RbinResponse
    - - software.amazon.awssdk.services.rbin.model.GetRuleResponse

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<GetRuleResponse.Builder,GetRuleResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class GetRuleResponse
extends RbinResponse
implements ToCopyableBuilder<GetRuleResponse.Builder,GetRuleResponse>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface GetRuleResponse.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`GetRuleResponse.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static GetRuleResponse.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()`
`boolean`	`hasResourceTags()` For responses, this returns true if the service returned a value for the ResourceTags property.
`String`	`identifier()` The unique ID of the retention rule.
`LockConfiguration`	`lockConfiguration()` Information about the retention rule lock configuration.
`Instant`	`lockEndTime()` The date and time at which the unlock delay is set to expire.
`LockState`	`lockState()` The lock state for the retention rule.
`String`	`lockStateAsString()` The lock state for the retention rule.
`List<ResourceTag>`	`resourceTags()` Information about the resource tags used to identify resources that are retained by the retention rule.
`ResourceType`	`resourceType()` The resource type retained by the retention rule.
`String`	`resourceTypeAsString()` The resource type retained by 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 GetRuleResponse.Builder>`	`serializableBuilderClass()`
`RuleStatus`	`status()` The state of the retention rule.
`String`	`statusAsString()` The state of the retention rule.
`GetRuleResponse.Builder`	`toBuilder()`
`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 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.
  - resourceType
```
public final ResourceType 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 return ResourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from resourceTypeAsString().
    
    Returns:
    
    The resource type retained by the retention rule.
    
    See Also:
    
    ResourceType
  - resourceTypeAsString
```
public final String 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 return ResourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from resourceTypeAsString().
    
    Returns:
    
    The resource type retained by the retention rule.
    
    See Also:
    
    ResourceType
  - 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.
  - 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 the isEmpty() 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
```
public final List<ResourceTag> 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
```
public final RuleStatus 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 return RuleStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    The state of the retention rule. Only retention rules that are in the available state retain resources.
    
    See Also:
    
    RuleStatus
  - statusAsString
```
public final String 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 return RuleStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    The state of the retention rule. Only retention rules that are in the available state retain resources.
    
    See Also:
    
    RuleStatus
  - lockConfiguration
```
public final LockConfiguration lockConfiguration()
```
    Information about the retention rule lock configuration.
    
    Returns:
    
    Information about the retention rule lock configuration.
  - 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
  - lockEndTime
```
public final Instant 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.
  - toBuilder
```
public GetRuleResponse.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<GetRuleResponse.Builder,GetRuleResponse>
    
    Overrides:
    
    toBuilder in class AwsResponse
  - builder
```
public static GetRuleResponse.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends GetRuleResponse.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsResponse
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsResponse
  - 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)
```
    Overrides:
    
    getValueForField in class SdkResponse
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class GetRuleResponse

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.services.rbin.model.RbinResponse

Methods inherited from class software.amazon.awssdk.core.SdkResponse

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

identifier

description

resourceType

resourceTypeAsString

retentionPeriod

hasResourceTags

resourceTags

status

statusAsString

lockConfiguration

lockState

lockStateAsString

lockEndTime

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields