com.amazonaws.services.elasticache.model

Class DescribeCacheClustersRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.elasticache.model.DescribeCacheClustersRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

Represents the input of a DescribeCacheClusters operation.

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DescribeCacheClustersRequest()

Method Summary

Modifier and Type	Method and Description
DescribeCacheClustersRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
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	getShowCacheClustersNotInReplicationGroups() An optional flag that can be included in the DescribeCacheCluster request to show only nodes (API/CLI: clusters) that are not members of a replication group.
Boolean	getShowCacheNodeInfo() An optional flag that can be included in the DescribeCacheCluster request to retrieve information about the individual cache nodes.
int	hashCode()
Boolean	isShowCacheClustersNotInReplicationGroups() An optional flag that can be included in the DescribeCacheCluster request to show only nodes (API/CLI: clusters) that are not members of a replication group.
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	setShowCacheClustersNotInReplicationGroups(Boolean showCacheClustersNotInReplicationGroups) An optional flag that can be included in the DescribeCacheCluster request to show only nodes (API/CLI: clusters) that are not members of a replication group.
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	withShowCacheClustersNotInReplicationGroups(Boolean showCacheClustersNotInReplicationGroups) An optional flag that can be included in the DescribeCacheCluster request to show only nodes (API/CLI: clusters) that are not members of a replication group.
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

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

DescribeCacheClustersRequest

public DescribeCacheClustersRequest()

Method Detail

setCacheClusterId

public void setCacheClusterId(String cacheClusterId)

The user-supplied cluster identifier. If this parameter is specified, only information about that specific 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 cluster is returned. This parameter isn't case sensitive.

getCacheClusterId

public String getCacheClusterId()

The user-supplied cluster identifier. If this parameter is specified, only information about that specific 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 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 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 cluster is returned. This parameter isn't case sensitive.

Returns:

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

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.

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.

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.

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:

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

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.

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.

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.

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:

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

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.

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.

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.

Parameters:

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

Returns:

Returns a reference to this 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.

setShowCacheClustersNotInReplicationGroups

public void setShowCacheClustersNotInReplicationGroups(Boolean showCacheClustersNotInReplicationGroups)

An optional flag that can be included in the DescribeCacheCluster request to show only nodes (API/CLI: clusters) that are not members of a replication group. In practice, this mean Memcached and single node Redis clusters.

Parameters:

showCacheClustersNotInReplicationGroups - An optional flag that can be included in the DescribeCacheCluster request to show only nodes (API/CLI: clusters) that are not members of a replication group. In practice, this mean Memcached and single node Redis clusters.

getShowCacheClustersNotInReplicationGroups

public Boolean getShowCacheClustersNotInReplicationGroups()

An optional flag that can be included in the DescribeCacheCluster request to show only nodes (API/CLI: clusters) that are not members of a replication group. In practice, this mean Memcached and single node Redis clusters.

Returns:

An optional flag that can be included in the DescribeCacheCluster request to show only nodes (API/CLI: clusters) that are not members of a replication group. In practice, this mean Memcached and single node Redis clusters.

withShowCacheClustersNotInReplicationGroups

public DescribeCacheClustersRequest withShowCacheClustersNotInReplicationGroups(Boolean showCacheClustersNotInReplicationGroups)

An optional flag that can be included in the DescribeCacheCluster request to show only nodes (API/CLI: clusters) that are not members of a replication group. In practice, this mean Memcached and single node Redis clusters.

Parameters:

showCacheClustersNotInReplicationGroups - An optional flag that can be included in the DescribeCacheCluster request to show only nodes (API/CLI: clusters) that are not members of a replication group. In practice, this mean Memcached and single node Redis clusters.

Returns:

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

isShowCacheClustersNotInReplicationGroups

public Boolean isShowCacheClustersNotInReplicationGroups()

An optional flag that can be included in the DescribeCacheCluster request to show only nodes (API/CLI: clusters) that are not members of a replication group. In practice, this mean Memcached and single node Redis clusters.

Returns:

An optional flag that can be included in the DescribeCacheCluster request to show only nodes (API/CLI: clusters) that are not members of a replication group. In practice, this mean Memcached and single node Redis clusters.

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

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public DescribeCacheClustersRequest 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()