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 description assigned to the retention rule.
`String`	`getIdentifier()` The unique ID of the retention rule.
`List<ResourceTag>`	`getResourceTags()` The resource tags used to identify resources that are to be retained by the retention rule.
`String`	`getResourceType()` The resource type retained by the retention rule.
`RetentionPeriod`	`getRetentionPeriod()` Information about the period for which the retention rule retains resources.
`String`	`getStatus()` The state of the retention rule.
`int`	`hashCode()`
`void`	`setDescription(String description)` The description assigned to the retention rule.
`void`	`setIdentifier(String identifier)` The unique ID of the retention rule.
`void`	`setResourceTags(Collection<ResourceTag> resourceTags)` The resource tags used to identify resources that are to be retained by the retention rule.
`void`	`setResourceType(String resourceType)` The resource type retained by the retention rule.
`void`	`setRetentionPeriod(RetentionPeriod retentionPeriod)` Information about the period for which the retention rule retains 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 description assigned to the retention rule.
`GetRuleResult`	`withIdentifier(String identifier)` The unique ID of the retention rule.
`GetRuleResult`	`withResourceTags(Collection<ResourceTag> resourceTags)` The resource tags used to identify resources that are to be retained by the retention rule.
`GetRuleResult`	`withResourceTags(ResourceTag... resourceTags)` The resource tags used to identify resources that are to be 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 period for which the retention rule retains 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 description assigned to the retention rule.
    
    Parameters:
    
    description - The description assigned to the retention rule.
  - getDescription
```
public String getDescription()
```
    The description assigned to the retention rule.
    
    Returns:
    
    The description assigned to the retention rule.
  - withDescription
```
public GetRuleResult withDescription(String description)
```
    The description assigned to the retention rule.
    
    Parameters:
    
    description - The description assigned to the retention rule.
    
    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. Currently, only Amazon EBS snapshots are supported.
    
    Parameters:
    
    resourceType - The resource type retained by the retention rule. Currently, only Amazon EBS snapshots are supported.
    
    See Also:
    
    ResourceType
  - getResourceType
```
public String getResourceType()
```
    The resource type retained by the retention rule. Currently, only Amazon EBS snapshots are supported.
    
    Returns:
    
    The resource type retained by the retention rule. Currently, only Amazon EBS snapshots are supported.
    
    See Also:
    
    ResourceType
  - withResourceType
```
public GetRuleResult withResourceType(String resourceType)
```
    The resource type retained by the retention rule. Currently, only Amazon EBS snapshots are supported.
    
    Parameters:
    
    resourceType - The resource type retained by the retention rule. Currently, only Amazon EBS snapshots are supported.
    
    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. Currently, only Amazon EBS snapshots are supported.
    
    Parameters:
    
    resourceType - The resource type retained by the retention rule. Currently, only Amazon EBS snapshots are supported.
    
    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 period for which the retention rule retains resources.
    
    Parameters:
    
    retentionPeriod - Information about the period for which the retention rule retains resources.
  - getRetentionPeriod
```
public RetentionPeriod getRetentionPeriod()
```
    Information about the period for which the retention rule retains resources.
    
    Returns:
    
    Information about the period for which the retention rule retains resources.
  - withRetentionPeriod
```
public GetRuleResult withRetentionPeriod(RetentionPeriod retentionPeriod)
```
    Information about the period for which the retention rule retains resources.
    
    Parameters:
    
    retentionPeriod - Information about the period for which the retention rule retains resources.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getResourceTags
```
public List<ResourceTag> getResourceTags()
```
    The resource tags used to identify resources that are to be retained by the retention rule.
    
    Returns:
    
    The resource tags used to identify resources that are to be retained by the retention rule.
  - setResourceTags
```
public void setResourceTags(Collection<ResourceTag> resourceTags)
```
    The resource tags used to identify resources that are to be retained by the retention rule.
    
    Parameters:
    
    resourceTags - The resource tags used to identify resources that are to be retained by the retention rule.
  - withResourceTags
```
public GetRuleResult withResourceTags(ResourceTag... resourceTags)
```
    The resource tags used to identify resources that are to be 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 - The resource tags used to identify resources that are to be 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)
```
    The resource tags used to identify resources that are to be retained by the retention rule.
    
    Parameters:
    
    resourceTags - The resource tags used to identify resources that are to be 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 snapshots.
    
    Parameters:
    
    status - The state of the retention rule. Only retention rules that are in the available state retain snapshots.
    
    See Also:
    
    RuleStatus
  - getStatus
```
public String getStatus()
```
    The state of the retention rule. Only retention rules that are in the available state retain snapshots.
    
    Returns:
    
    The state of the retention rule. Only retention rules that are in the available state retain snapshots.
    
    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 snapshots.
    
    Parameters:
    
    status - The state of the retention rule. Only retention rules that are in the available state retain snapshots.
    
    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 snapshots.
    
    Parameters:
    
    status - The state of the retention rule. Only retention rules that are in the available state retain snapshots.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    RuleStatus
  - 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

toString

equals

hashCode

clone