Did this page help you?

   Yes   No   Tell us about it...

com.amazonaws.services.elasticache.model
Class DescribeCacheParameterGroupsRequest

java.lang.Object
  extended by com.amazonaws.AmazonWebServiceRequest
      extended by com.amazonaws.services.elasticache.model.DescribeCacheParameterGroupsRequest
All Implemented Interfaces:
Serializable

public class DescribeCacheParameterGroupsRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the DescribeCacheParameterGroups operation.

Returns a list of CacheParameterGroup descriptions. If a CacheParameterGroupName is specified, the list will contain only the descriptions of the specified CacheParameterGroup.

See Also:
AmazonElastiCache.describeCacheParameterGroups(DescribeCacheParameterGroupsRequest), Serialized Form

Constructor Summary
DescribeCacheParameterGroupsRequest()
          Default constructor for a new DescribeCacheParameterGroupsRequest object.
DescribeCacheParameterGroupsRequest(String cacheParameterGroupName)
          Constructs a new DescribeCacheParameterGroupsRequest object.
 
Method Summary
 boolean equals(Object obj)
           
 String getCacheParameterGroupName()
          The name of a specific cache parameter group to return details for.
 String getMarker()
          An optional marker provided in the previous DescribeCacheParameterGroups 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 provided in the previous DescribeCacheParameterGroups 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 provided in the previous DescribeCacheParameterGroups request.
 DescribeCacheParameterGroupsRequest withMaxRecords(Integer maxRecords)
          The maximum number of records to include in the response.
 
Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, setRequestCredentials
 
Methods inherited from class java.lang.Object
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 may be retrieved.

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 may be retrieved.

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 may be retrieved.

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 may be retrieved.

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 may be retrieved.

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 may be retrieved.
Returns:
A reference to this updated object so that method calls can be chained together.

getMarker

public String getMarker()
An optional marker provided in the previous DescribeCacheParameterGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Returns:
An optional marker provided in the previous DescribeCacheParameterGroups request. 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 provided in the previous DescribeCacheParameterGroups request. 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 provided in the previous DescribeCacheParameterGroups request. 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 provided in the previous DescribeCacheParameterGroups request. 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 provided in the previous DescribeCacheParameterGroups request. 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


Copyright © 2010 Amazon Web Services, Inc. All Rights Reserved.