com.amazonaws.services.recyclebin.model

Class UnlockRuleResult

java.lang.Object

com.amazonaws.AmazonWebServiceResult<ResponseMetadata>

com.amazonaws.services.recyclebin.model.UnlockRuleResult

All Implemented Interfaces:

Serializable, Cloneable

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

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
UnlockRuleResult()

Method Summary

Modifier and Type	Method and Description
UnlockRuleResult	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()
String	getRuleArn() The Amazon Resource Name (ARN) of the retention rule.
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)
void	setRuleArn(String ruleArn) The Amazon Resource Name (ARN) of the retention rule.
void	setStatus(String status) The state of the retention rule.
String	toString() Returns a string representation of this object.
UnlockRuleResult	withDescription(String description) The retention rule description.
UnlockRuleResult	withIdentifier(String identifier) The unique ID of the retention rule.
UnlockRuleResult	withLockConfiguration(LockConfiguration lockConfiguration) Information about the retention rule lock configuration.
UnlockRuleResult	withLockEndTime(Date lockEndTime) The date and time at which the unlock delay is set to expire.
UnlockRuleResult	withLockState(LockState lockState) The lock state for the retention rule.
UnlockRuleResult	withLockState(String lockState) The lock state for the retention rule.
UnlockRuleResult	withResourceTags(Collection<ResourceTag> resourceTags) Information about the resource tags used to identify resources that are retained by the retention rule.
UnlockRuleResult	withResourceTags(ResourceTag... resourceTags) Information about the resource tags used to identify resources that are retained by the retention rule.
UnlockRuleResult	withResourceType(ResourceType resourceType) The resource type retained by the retention rule.
UnlockRuleResult	withResourceType(String resourceType) The resource type retained by the retention rule.
UnlockRuleResult	withRetentionPeriod(RetentionPeriod retentionPeriod)
UnlockRuleResult	withRuleArn(String ruleArn) The Amazon Resource Name (ARN) of the retention rule.
UnlockRuleResult	withStatus(RuleStatus status) The state of the retention rule.
UnlockRuleResult	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

UnlockRuleResult

public UnlockRuleResult()

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 UnlockRuleResult 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 UnlockRuleResult 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 UnlockRuleResult 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 UnlockRuleResult 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)

Parameters:

retentionPeriod -

getRetentionPeriod

public RetentionPeriod getRetentionPeriod()

Returns:

withRetentionPeriod

public UnlockRuleResult withRetentionPeriod(RetentionPeriod retentionPeriod)

Parameters:

retentionPeriod -

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 UnlockRuleResult 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 UnlockRuleResult 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 UnlockRuleResult 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 UnlockRuleResult 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 UnlockRuleResult 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 UnlockRuleResult 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 UnlockRuleResult 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 UnlockRuleResult 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.

setRuleArn

public void setRuleArn(String ruleArn)

The Amazon Resource Name (ARN) of the retention rule.

Parameters:

ruleArn - The Amazon Resource Name (ARN) of the retention rule.

getRuleArn

public String getRuleArn()

The Amazon Resource Name (ARN) of the retention rule.

Returns:

The Amazon Resource Name (ARN) of the retention rule.

withRuleArn

public UnlockRuleResult withRuleArn(String ruleArn)

The Amazon Resource Name (ARN) of the retention rule.

Parameters:

ruleArn - The Amazon Resource Name (ARN) of the retention rule.

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 UnlockRuleResult clone()

Overrides:

clone in class Object