com.amazonaws.services.recyclebin.model

Class ListRulesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.recyclebin.model.ListRulesRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ListRulesRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
ListRulesRequest()

Method Summary

Modifier and Type	Method and Description
ListRulesRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getLockState() The lock state of the retention rules to list.
Integer	getMaxResults() The maximum number of results to return with a single call.
String	getNextToken() The token for the next page of results.
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.
int	hashCode()
void	setLockState(String lockState) The lock state of the retention rules to list.
void	setMaxResults(Integer maxResults) The maximum number of results to return with a single call.
void	setNextToken(String nextToken) The token for the next page of results.
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.
String	toString() Returns a string representation of this object.
ListRulesRequest	withLockState(LockState lockState) The lock state of the retention rules to list.
ListRulesRequest	withLockState(String lockState) The lock state of the retention rules to list.
ListRulesRequest	withMaxResults(Integer maxResults) The maximum number of results to return with a single call.
ListRulesRequest	withNextToken(String nextToken) The token for the next page of results.
ListRulesRequest	withResourceTags(Collection<ResourceTag> resourceTags) Information about the resource tags used to identify resources that are retained by the retention rule.
ListRulesRequest	withResourceTags(ResourceTag... resourceTags) Information about the resource tags used to identify resources that are retained by the retention rule.
ListRulesRequest	withResourceType(ResourceType resourceType) The resource type retained by the retention rule.
ListRulesRequest	withResourceType(String resourceType) The resource type retained by the retention rule.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ListRulesRequest

public ListRulesRequest()

Method Detail

setMaxResults

public void setMaxResults(Integer maxResults)

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned NextToken value.

Parameters:

maxResults - The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned NextToken value.

getMaxResults

public Integer getMaxResults()

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned NextToken value.

Returns:

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned NextToken value.

withMaxResults

public ListRulesRequest withMaxResults(Integer maxResults)

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned NextToken value.

Parameters:

maxResults - The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned NextToken value.

Returns:

Returns a reference to this object so that method calls can be chained together.

setNextToken

public void setNextToken(String nextToken)

The token for the next page of results.

Parameters:

nextToken - The token for the next page of results.

getNextToken

public String getNextToken()

The token for the next page of results.

Returns:

The token for the next page of results.

withNextToken

public ListRulesRequest withNextToken(String nextToken)

The token for the next page of results.

Parameters:

nextToken - The token for the next page of results.

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. Only retention rules that retain the specified resource type are listed. Currently, only Amazon EBS snapshots and EBS-backed AMIs are supported. To list retention rules that retain snapshots, specify EBS_SNAPSHOT. To list retention rules that retain EBS-backed AMIs, specify EC2_IMAGE.

Parameters:

resourceType - The resource type retained by the retention rule. Only retention rules that retain the specified resource type are listed. Currently, only Amazon EBS snapshots and EBS-backed AMIs are supported. To list retention rules that retain snapshots, specify EBS_SNAPSHOT. To list retention rules that retain EBS-backed AMIs, specify EC2_IMAGE.

See Also:

ResourceType

getResourceType

public String getResourceType()

The resource type retained by the retention rule. Only retention rules that retain the specified resource type are listed. Currently, only Amazon EBS snapshots and EBS-backed AMIs are supported. To list retention rules that retain snapshots, specify EBS_SNAPSHOT. To list retention rules that retain EBS-backed AMIs, specify EC2_IMAGE.

Returns:

The resource type retained by the retention rule. Only retention rules that retain the specified resource type are listed. Currently, only Amazon EBS snapshots and EBS-backed AMIs are supported. To list retention rules that retain snapshots, specify EBS_SNAPSHOT. To list retention rules that retain EBS-backed AMIs, specify EC2_IMAGE.

See Also:

ResourceType

withResourceType

public ListRulesRequest withResourceType(String resourceType)

The resource type retained by the retention rule. Only retention rules that retain the specified resource type are listed. Currently, only Amazon EBS snapshots and EBS-backed AMIs are supported. To list retention rules that retain snapshots, specify EBS_SNAPSHOT. To list retention rules that retain EBS-backed AMIs, specify EC2_IMAGE.

Parameters:

resourceType - The resource type retained by the retention rule. Only retention rules that retain the specified resource type are listed. Currently, only Amazon EBS snapshots and EBS-backed AMIs are supported. To list retention rules that retain snapshots, specify EBS_SNAPSHOT. To list retention rules that retain EBS-backed AMIs, specify EC2_IMAGE.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ResourceType

withResourceType

public ListRulesRequest withResourceType(ResourceType resourceType)

The resource type retained by the retention rule. Only retention rules that retain the specified resource type are listed. Currently, only Amazon EBS snapshots and EBS-backed AMIs are supported. To list retention rules that retain snapshots, specify EBS_SNAPSHOT. To list retention rules that retain EBS-backed AMIs, specify EC2_IMAGE.

Parameters:

resourceType - The resource type retained by the retention rule. Only retention rules that retain the specified resource type are listed. Currently, only Amazon EBS snapshots and EBS-backed AMIs are supported. To list retention rules that retain snapshots, specify EBS_SNAPSHOT. To list retention rules that retain EBS-backed AMIs, specify EC2_IMAGE.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ResourceType

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

setLockState

public void setLockState(String lockState)

The lock state of the retention rules to list. Only retention rules with the specified lock state are returned.

Parameters:

lockState - The lock state of the retention rules to list. Only retention rules with the specified lock state are returned.

See Also:

LockState

getLockState

public String getLockState()

The lock state of the retention rules to list. Only retention rules with the specified lock state are returned.

Returns:

The lock state of the retention rules to list. Only retention rules with the specified lock state are returned.

See Also:

LockState

withLockState

public ListRulesRequest withLockState(String lockState)

The lock state of the retention rules to list. Only retention rules with the specified lock state are returned.

Parameters:

lockState - The lock state of the retention rules to list. Only retention rules with the specified lock state are returned.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

LockState

withLockState

public ListRulesRequest withLockState(LockState lockState)

The lock state of the retention rules to list. Only retention rules with the specified lock state are returned.

Parameters:

lockState - The lock state of the retention rules to list. Only retention rules with the specified lock state are returned.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

LockState

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

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()