GetRuleResult (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceResult<ResponseMetadata>
- - com.amazonaws.services.recyclebin.model.GetRuleResult

All Implemented Interfaces:: Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class GetRuleResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

GetRuleResult()

Constructors
Constructor and Description
`GetRuleResult()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GetRuleResult`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getDescription()` The retention rule description.
`String`	`getIdentifier()` The unique ID of the retention rule.
`LockConfiguration`	`getLockConfiguration()` Information about the retention rule lock configuration.
`Date`	`getLockEndTime()` The date and time at which the unlock delay is set to expire.
`String`	`getLockState()` The lock state for the retention rule.
`List<ResourceTag>`	`getResourceTags()` Information about the resource tags used to identify resources that are retained by the retention rule.
`String`	`getResourceType()` The resource type retained by the retention rule.
`RetentionPeriod`	`getRetentionPeriod()` Information about the retention period for which the retention rule is to retain resources.
`String`	`getStatus()` The state of the retention rule.
`int`	`hashCode()`
`void`	`setDescription(String description)` The retention rule description.
`void`	`setIdentifier(String identifier)` The unique ID of the retention rule.
`void`	`setLockConfiguration(LockConfiguration lockConfiguration)` Information about the retention rule lock configuration.
`void`	`setLockEndTime(Date lockEndTime)` The date and time at which the unlock delay is set to expire.
`void`	`setLockState(String lockState)` The lock state for the retention rule.
`void`	`setResourceTags(Collection<ResourceTag> resourceTags)` Information about the resource tags used to identify resources that are retained by the retention rule.
`void`	`setResourceType(String resourceType)` The resource type retained by the retention rule.
`void`	`setRetentionPeriod(RetentionPeriod retentionPeriod)` Information about the retention period for which the retention rule is to retain resources.
`void`	`setStatus(String status)` The state of the retention rule.
`String`	`toString()` Returns a string representation of this object.
`GetRuleResult`	`withDescription(String description)` The retention rule description.
`GetRuleResult`	`withIdentifier(String identifier)` The unique ID of the retention rule.
`GetRuleResult`	`withLockConfiguration(LockConfiguration lockConfiguration)` Information about the retention rule lock configuration.
`GetRuleResult`	`withLockEndTime(Date lockEndTime)` The date and time at which the unlock delay is set to expire.
`GetRuleResult`	`withLockState(LockState lockState)` The lock state for the retention rule.
`GetRuleResult`	`withLockState(String lockState)` The lock state for the retention rule.
`GetRuleResult`	`withResourceTags(Collection<ResourceTag> resourceTags)` Information about the resource tags used to identify resources that are retained by the retention rule.
`GetRuleResult`	`withResourceTags(ResourceTag... resourceTags)` Information about the resource tags used to identify resources that are retained by the retention rule.
`GetRuleResult`	`withResourceType(ResourceType resourceType)` The resource type retained by the retention rule.
`GetRuleResult`	`withResourceType(String resourceType)` The resource type retained by the retention rule.
`GetRuleResult`	`withRetentionPeriod(RetentionPeriod retentionPeriod)` Information about the retention period for which the retention rule is to retain resources.
`GetRuleResult`	`withStatus(RuleStatus status)` The state of the retention rule.
`GetRuleResult`	`withStatus(String status)` The state of the retention rule.

Methods inherited from class com.amazonaws.AmazonWebServiceResult
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - GetRuleResult
```
public GetRuleResult()
```
- Method Detail
  - setIdentifier
```
public void setIdentifier(String identifier)
```
    The unique ID of the retention rule.
    
    Parameters:
    
    identifier - The unique ID of the retention rule.
  - getIdentifier
```
public String getIdentifier()
```
    The unique ID of the retention rule.
    
    Returns:
    
    The unique ID of the retention rule.
  - withIdentifier
```
public GetRuleResult withIdentifier(String identifier)
```
    The unique ID of the retention rule.
    
    Parameters:
    
    identifier - The unique ID of the retention rule.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescription
```
public void setDescription(String description)
```
    The retention rule description.
    
    Parameters:
    
    description - The retention rule description.
  - getDescription
```
public String getDescription()
```
    The retention rule description.
    
    Returns:
    
    The retention rule description.
  - withDescription
```
public GetRuleResult withDescription(String description)
```
    The retention rule description.
    
    Parameters:
    
    description - The retention rule description.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setResourceType
```
public void setResourceType(String resourceType)
```
    The resource type retained by the retention rule.
    
    Parameters:
    
    resourceType - The resource type retained by the retention rule.
    
    See Also:
    
    ResourceType
  - getResourceType
```
public String getResourceType()
```
    The resource type retained by the retention rule.
    
    Returns:
    
    The resource type retained by the retention rule.
    
    See Also:
    
    ResourceType
  - withResourceType
```
public GetRuleResult withResourceType(String resourceType)
```
    The resource type retained by the retention rule.
    
    Parameters:
    
    resourceType - The resource type retained by the retention rule.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ResourceType
  - withResourceType
```
public GetRuleResult withResourceType(ResourceType resourceType)
```
    The resource type retained by the retention rule.
    
    Parameters:
    
    resourceType - The resource type retained by the retention rule.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ResourceType
  - setRetentionPeriod
```
public void setRetentionPeriod(RetentionPeriod retentionPeriod)
```
    Information about the retention period for which the retention rule is to retain resources.
    
    Parameters:
    
    retentionPeriod - Information about the retention period for which the retention rule is to retain resources.
  - getRetentionPeriod
```
public RetentionPeriod getRetentionPeriod()
```
    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.
  - withRetentionPeriod
```
public GetRuleResult withRetentionPeriod(RetentionPeriod retentionPeriod)
```
    Information about the retention period for which the retention rule is to retain resources.
    
    Parameters:
    
    retentionPeriod - Information about the retention period for which the retention rule is to retain resources.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getResourceTags
```
public List<ResourceTag> getResourceTags()
```
    Information about the resource tags used to identify resources that are retained by the retention rule.
    
    Returns:
    
    Information about the resource tags used to identify resources that are retained by the retention rule.
  - setResourceTags
```
public void setResourceTags(Collection<ResourceTag> resourceTags)
```
    Information about the resource tags used to identify resources that are retained by the retention rule.
    
    Parameters:
    
    resourceTags - Information about the resource tags used to identify resources that are retained by the retention rule.
  - withResourceTags
```
public GetRuleResult withResourceTags(ResourceTag... resourceTags)
```
    Information about the resource tags used to identify resources that are retained by the retention rule.
    
    NOTE: This method appends the values to the existing list (if any). Use setResourceTags(java.util.Collection) or withResourceTags(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    resourceTags - Information about the resource tags used to identify resources that are retained by the retention rule.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withResourceTags
```
public GetRuleResult withResourceTags(Collection<ResourceTag> resourceTags)
```
    Information about the resource tags used to identify resources that are retained by the retention rule.
    
    Parameters:
    
    resourceTags - Information about the resource tags used to identify resources that are retained by the retention rule.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatus
```
public void setStatus(String status)
```
    The state of the retention rule. Only retention rules that are in the available state retain resources.
    
    Parameters:
    
    status - The state of the retention rule. Only retention rules that are in the available state retain resources.
    
    See Also:
    
    RuleStatus
  - getStatus
```
public String getStatus()
```
    The state of the retention rule. Only retention rules that are in the available state retain resources.
    
    Returns:
    
    The state of the retention rule. Only retention rules that are in the available state retain resources.
    
    See Also:
    
    RuleStatus
  - withStatus
```
public GetRuleResult withStatus(String status)
```
    The state of the retention rule. Only retention rules that are in the available state retain resources.
    
    Parameters:
    
    status - The state of the retention rule. Only retention rules that are in the available state retain resources.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    RuleStatus
  - withStatus
```
public GetRuleResult withStatus(RuleStatus status)
```
    The state of the retention rule. Only retention rules that are in the available state retain resources.
    
    Parameters:
    
    status - The state of the retention rule. Only retention rules that are in the available state retain resources.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    RuleStatus
  - setLockConfiguration
```
public void setLockConfiguration(LockConfiguration lockConfiguration)
```
    Information about the retention rule lock configuration.
    
    Parameters:
    
    lockConfiguration - Information about the retention rule lock configuration.
  - getLockConfiguration
```
public LockConfiguration getLockConfiguration()
```
    Information about the retention rule lock configuration.
    
    Returns:
    
    Information about the retention rule lock configuration.
  - withLockConfiguration
```
public GetRuleResult withLockConfiguration(LockConfiguration lockConfiguration)
```
    Information about the retention rule lock configuration.
    
    Parameters:
    
    lockConfiguration - Information about the retention rule lock configuration.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLockState
```
public void setLockState(String 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.
    Parameters:
    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.
    See Also:
    
    LockState
  - getLockState
```
public String getLockState()
```
    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.
    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
  - withLockState
```
public GetRuleResult withLockState(String 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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    LockState
  - withLockState
```
public GetRuleResult withLockState(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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    LockState
  - setLockEndTime
```
public void setLockEndTime(Date 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.
    
    Parameters:
    
    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.
  - getLockEndTime
```
public Date getLockEndTime()
```
    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.
  - withLockEndTime
```
public GetRuleResult withLockEndTime(Date 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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public GetRuleResult clone()
```
    Overrides:
    
    clone in class Object

Did this page help you?

Class GetRuleResult

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceResult

Methods inherited from class java.lang.Object

Constructor Detail

GetRuleResult

Method Detail

setIdentifier

getIdentifier

withIdentifier

setDescription

getDescription

withDescription

setResourceType

getResourceType

withResourceType

withResourceType

setRetentionPeriod

getRetentionPeriod

withRetentionPeriod

getResourceTags

setResourceTags

withResourceTags

withResourceTags

setStatus

getStatus

withStatus

withStatus

setLockConfiguration

getLockConfiguration

withLockConfiguration

setLockState

getLockState

withLockState

withLockState

setLockEndTime

getLockEndTime

withLockEndTime

toString

equals

hashCode

clone