com.amazonaws.services.cloudhsmv2.model

Class DescribeClustersRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cloudhsmv2.model.DescribeClustersRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DescribeClustersRequest
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
DescribeClustersRequest()

Method Summary

Modifier and Type	Method and Description
DescribeClustersRequest	addFiltersEntry(String key, List<String> value) Add a single Filters entry
DescribeClustersRequest	clearFiltersEntries() Removes all the entries added into Filters.
DescribeClustersRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
Map<String,List<String>>	getFilters() One or more filters to limit the items returned in the response.
Integer	getMaxResults() The maximum number of clusters to return in the response.
String	getNextToken() The NextToken value that you received in the previous response.
int	hashCode()
void	setFilters(Map<String,List<String>> filters) One or more filters to limit the items returned in the response.
void	setMaxResults(Integer maxResults) The maximum number of clusters to return in the response.
void	setNextToken(String nextToken) The NextToken value that you received in the previous response.
String	toString() Returns a string representation of this object.
DescribeClustersRequest	withFilters(Map<String,List<String>> filters) One or more filters to limit the items returned in the response.
DescribeClustersRequest	withMaxResults(Integer maxResults) The maximum number of clusters to return in the response.
DescribeClustersRequest	withNextToken(String nextToken) The NextToken value that you received in the previous response.

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

DescribeClustersRequest

public DescribeClustersRequest()

Method Detail

getFilters

public Map<String,List<String>> getFilters()

One or more filters to limit the items returned in the response.

Use the clusterIds filter to return only the specified clusters. Specify clusters by their cluster identifier (ID).

Use the vpcIds filter to return only the clusters in the specified virtual private clouds (VPCs). Specify VPCs by their VPC identifier (ID).

Use the states filter to return only clusters that match the specified state.

Returns:

One or more filters to limit the items returned in the response.

Use the clusterIds filter to return only the specified clusters. Specify clusters by their cluster identifier (ID).

Use the vpcIds filter to return only the clusters in the specified virtual private clouds (VPCs). Specify VPCs by their VPC identifier (ID).

Use the states filter to return only clusters that match the specified state.

setFilters

public void setFilters(Map<String,List<String>> filters)

One or more filters to limit the items returned in the response.

Use the clusterIds filter to return only the specified clusters. Specify clusters by their cluster identifier (ID).

Use the vpcIds filter to return only the clusters in the specified virtual private clouds (VPCs). Specify VPCs by their VPC identifier (ID).

Use the states filter to return only clusters that match the specified state.

Parameters:

filters - One or more filters to limit the items returned in the response.

Use the clusterIds filter to return only the specified clusters. Specify clusters by their cluster identifier (ID).

Use the vpcIds filter to return only the clusters in the specified virtual private clouds (VPCs). Specify VPCs by their VPC identifier (ID).

Use the states filter to return only clusters that match the specified state.

withFilters

public DescribeClustersRequest withFilters(Map<String,List<String>> filters)

One or more filters to limit the items returned in the response.

Use the clusterIds filter to return only the specified clusters. Specify clusters by their cluster identifier (ID).

Use the vpcIds filter to return only the clusters in the specified virtual private clouds (VPCs). Specify VPCs by their VPC identifier (ID).

Use the states filter to return only clusters that match the specified state.

Parameters:

filters - One or more filters to limit the items returned in the response.

Use the clusterIds filter to return only the specified clusters. Specify clusters by their cluster identifier (ID).

Use the vpcIds filter to return only the clusters in the specified virtual private clouds (VPCs). Specify VPCs by their VPC identifier (ID).

Use the states filter to return only clusters that match the specified state.

Returns:

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

addFiltersEntry

public DescribeClustersRequest addFiltersEntry(String key,
                                               List<String> value)

Add a single Filters entry

See Also:

withFilters(java.util.Map<java.lang.String, java.util.List<java.lang.String>>)

clearFiltersEntries

public DescribeClustersRequest clearFiltersEntries()

Removes all the entries added into Filters.

Returns:

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

setNextToken

public void setNextToken(String nextToken)

The NextToken value that you received in the previous response. Use this value to get more clusters.

Parameters:

nextToken - The NextToken value that you received in the previous response. Use this value to get more clusters.

getNextToken

public String getNextToken()

The NextToken value that you received in the previous response. Use this value to get more clusters.

Returns:

The NextToken value that you received in the previous response. Use this value to get more clusters.

withNextToken

public DescribeClustersRequest withNextToken(String nextToken)

The NextToken value that you received in the previous response. Use this value to get more clusters.

Parameters:

nextToken - The NextToken value that you received in the previous response. Use this value to get more clusters.

Returns:

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

setMaxResults

public void setMaxResults(Integer maxResults)

The maximum number of clusters to return in the response. When there are more clusters than the number you specify, the response contains a NextToken value.

Parameters:

maxResults - The maximum number of clusters to return in the response. When there are more clusters than the number you specify, the response contains a NextToken value.

getMaxResults

public Integer getMaxResults()

The maximum number of clusters to return in the response. When there are more clusters than the number you specify, the response contains a NextToken value.

Returns:

The maximum number of clusters to return in the response. When there are more clusters than the number you specify, the response contains a NextToken value.

withMaxResults

public DescribeClustersRequest withMaxResults(Integer maxResults)

The maximum number of clusters to return in the response. When there are more clusters than the number you specify, the response contains a NextToken value.

Parameters:

maxResults - The maximum number of clusters to return in the response. When there are more clusters than the number you specify, the response contains a NextToken value.

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 DescribeClustersRequest 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()