com.amazonaws.services.elasticache.model

Class DescribeCacheParameterGroupsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.elasticache.model.DescribeCacheParameterGroupsRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class DescribeCacheParameterGroupsRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the DescribeCacheParameterGroups operation.

The DescribeCacheParameterGroups action returns a list of cache parameter group descriptions. If a cache parameter group name is specified, the list will contain only the descriptions for that group.

See Also:

AmazonElastiCache.describeCacheParameterGroups(DescribeCacheParameterGroupsRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DescribeCacheParameterGroupsRequest() Default constructor for a new DescribeCacheParameterGroupsRequest object.
DescribeCacheParameterGroupsRequest(String cacheParameterGroupName) Constructs a new DescribeCacheParameterGroupsRequest object.

Method Summary

Methods

Modifier and Type	Method and Description
DescribeCacheParameterGroupsRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
String	getCacheParameterGroupName() The name of a specific cache parameter group to return details for.
String	getMarker() An optional marker returned from a prior request.
Integer	getMaxRecords() The maximum number of records to include in the response.
int	hashCode()
void	setCacheParameterGroupName(String cacheParameterGroupName) The name of a specific cache parameter group to return details for.
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.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DescribeCacheParameterGroupsRequest	withCacheParameterGroupName(String cacheParameterGroupName) The name of a specific cache parameter group to return details for.
DescribeCacheParameterGroupsRequest	withMarker(String marker) An optional marker returned from a prior request.
DescribeCacheParameterGroupsRequest	withMaxRecords(Integer maxRecords) The maximum number of records to include in the response.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

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

Constructor Detail

DescribeCacheParameterGroupsRequest

public DescribeCacheParameterGroupsRequest()

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

DescribeCacheParameterGroupsRequest

public DescribeCacheParameterGroupsRequest(String cacheParameterGroupName)

Constructs a new DescribeCacheParameterGroupsRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

Parameters:

cacheParameterGroupName - The name of a specific cache parameter group to return details for.

Method Detail

getCacheParameterGroupName

public String getCacheParameterGroupName()

The name of a specific cache parameter group to return details for.

Returns:

The name of a specific cache parameter group to return details for.

setCacheParameterGroupName

public void setCacheParameterGroupName(String cacheParameterGroupName)

The name of a specific cache parameter group to return details for.

Parameters:

cacheParameterGroupName - The name of a specific cache parameter group to return details for.

withCacheParameterGroupName

public DescribeCacheParameterGroupsRequest withCacheParameterGroupName(String cacheParameterGroupName)

The name of a specific cache parameter group to return details for.

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

Parameters:

cacheParameterGroupName - The name of a specific cache parameter group to return details for.

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 DescribeCacheParameterGroupsRequest 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 action. 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 action. 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 action. 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 action. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

withMarker

public DescribeCacheParameterGroupsRequest withMarker(String marker)

An optional marker returned from a prior request. Use this marker for pagination of results from this action. 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 action. 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.

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

clone

public DescribeCacheParameterGroupsRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()