com.amazonaws.services.elasticache.model
Class DescribeCacheClustersRequest

java.lang.Object
  com.amazonaws.AmazonWebServiceRequest
      com.amazonaws.services.elasticache.model.DescribeCacheClustersRequest

All Implemented Interfaces:

Serializable

public class DescribeCacheClustersRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the DescribeCacheClusters operation.

The DescribeCacheClusters operation returns information about all provisioned cache clusters if no cache cluster identifier is specified, or about a specific cache cluster if a cache cluster identifier is supplied.

By default, abbreviated information about the cache clusters(s) will be returned. You can use the optional ShowDetails flag to retrieve detailed information about the cache nodes associated with the cache clusters. These details include the DNS address and port for the cache node endpoint.

If the cluster is in the CREATING state, only cluster level information will be displayed until all of the nodes are successfully provisioned.

If the cluster is in the DELETING state, only cluster level information will be displayed.

If cache nodes are currently being added to the cache cluster, node endpoint information and creation time for the additional nodes will not be displayed until they are completely provisioned. When the cache cluster state is available , the cluster is ready for use.

If cache nodes are currently being removed from the cache cluster, no endpoint information for the removed nodes is displayed.

See Also:

AmazonElastiCache.describeCacheClusters(DescribeCacheClustersRequest), Serialized Form

Constructor Summary

DescribeCacheClustersRequest()
Default constructor for a new DescribeCacheClustersRequest object.

Method Summary

boolean	equals(Object obj)
String	getCacheClusterId() The user-supplied cluster identifier.
String	getMarker() An optional marker returned from a prior request.
Integer	getMaxRecords() The maximum number of records to include in the response.
Boolean	getShowCacheNodeInfo() An optional flag that can be included in the DescribeCacheCluster request to retrieve information about the individual cache nodes.
int	hashCode()
Boolean	isShowCacheNodeInfo() An optional flag that can be included in the DescribeCacheCluster request to retrieve information about the individual cache nodes.
void	setCacheClusterId(String cacheClusterId) The user-supplied cluster identifier.
void	setMarker(String marker) An optional marker returned from a prior request.
void	setMaxRecords(Integer maxRecords) The maximum number of records to include in the response.
void	setShowCacheNodeInfo(Boolean showCacheNodeInfo) An optional flag that can be included in the DescribeCacheCluster request to retrieve information about the individual cache nodes.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DescribeCacheClustersRequest	withCacheClusterId(String cacheClusterId) The user-supplied cluster identifier.
DescribeCacheClustersRequest	withMarker(String marker) An optional marker returned from a prior request.
DescribeCacheClustersRequest	withMaxRecords(Integer maxRecords) The maximum number of records to include in the response.
DescribeCacheClustersRequest	withShowCacheNodeInfo(Boolean showCacheNodeInfo) An optional flag that can be included in the DescribeCacheCluster request to retrieve information about the individual cache nodes.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setRequestCredentials, setRequestMetricCollector, withRequestMetricCollector

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DescribeCacheClustersRequest

public DescribeCacheClustersRequest()

Default constructor for a new DescribeCacheClustersRequest object. Callers should use the setter or fluent setter (with...) methods to initialize this object after creating it.

Method Detail

getCacheClusterId

public String getCacheClusterId()

The user-supplied cluster identifier. If this parameter is specified, only information about that specific cache cluster is returned. This parameter isn't case sensitive.

Returns:

The user-supplied cluster identifier. If this parameter is specified, only information about that specific cache cluster is returned. This parameter isn't case sensitive.

setCacheClusterId

public void setCacheClusterId(String cacheClusterId)

The user-supplied cluster identifier. If this parameter is specified, only information about that specific cache cluster is returned. This parameter isn't case sensitive.

Parameters:

cacheClusterId - The user-supplied cluster identifier. If this parameter is specified, only information about that specific cache cluster is returned. This parameter isn't case sensitive.

withCacheClusterId

public DescribeCacheClustersRequest withCacheClusterId(String cacheClusterId)

The user-supplied cluster identifier. If this parameter is specified, only information about that specific cache cluster is returned. This parameter isn't case sensitive.

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

Parameters:

cacheClusterId - The user-supplied cluster identifier. If this parameter is specified, only information about that specific cache cluster is returned. This parameter isn't case sensitive.

Returns:

A reference to this updated object so that method calls can be chained together.

getMaxRecords

public Integer getMaxRecords()

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20; maximum 100.

Returns:

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20; maximum 100.

setMaxRecords

public void setMaxRecords(Integer maxRecords)

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20; maximum 100.

Parameters:

maxRecords - The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20; maximum 100.

withMaxRecords

public DescribeCacheClustersRequest withMaxRecords(Integer maxRecords)

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20; maximum 100.

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

Parameters:

maxRecords - The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20; maximum 100.

Returns:

A reference to this updated object so that method calls can be chained together.

getMarker

public String getMarker()

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Returns:

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

setMarker

public void setMarker(String marker)

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Parameters:

marker - An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

withMarker

public DescribeCacheClustersRequest withMarker(String marker)

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

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

Parameters:

marker - An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Returns:

A reference to this updated object so that method calls can be chained together.

isShowCacheNodeInfo

public Boolean isShowCacheNodeInfo()

An optional flag that can be included in the DescribeCacheCluster request to retrieve information about the individual cache nodes.

Returns:

An optional flag that can be included in the DescribeCacheCluster request to retrieve information about the individual cache nodes.

setShowCacheNodeInfo

public void setShowCacheNodeInfo(Boolean showCacheNodeInfo)

An optional flag that can be included in the DescribeCacheCluster request to retrieve information about the individual cache nodes.

Parameters:

showCacheNodeInfo - An optional flag that can be included in the DescribeCacheCluster request to retrieve information about the individual cache nodes.

withShowCacheNodeInfo

public DescribeCacheClustersRequest withShowCacheNodeInfo(Boolean showCacheNodeInfo)

An optional flag that can be included in the DescribeCacheCluster request to retrieve information about the individual cache nodes.

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

Parameters:

showCacheNodeInfo - An optional flag that can be included in the DescribeCacheCluster request to retrieve information about the individual cache nodes.

Returns:

A reference to this updated object so that method calls can be chained together.

getShowCacheNodeInfo

public Boolean getShowCacheNodeInfo()

An optional flag that can be included in the DescribeCacheCluster request to retrieve information about the individual cache nodes.

Returns:

An optional flag that can be included in the DescribeCacheCluster request to retrieve information about the individual cache nodes.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object