Class DescribeCacheClustersRequest

java.lang.Object
com.amazonaws.AmazonWebServiceRequest
com.amazonaws.services.elasticache.model.DescribeCacheClustersRequest
All Implemented Interfaces:
ReadLimitInfo, Serializable, Cloneable

public class DescribeCacheClustersRequest extends AmazonWebServiceRequest implements Serializable, Cloneable

Represents the input of a DescribeCacheClusters action.

See Also:
  • Constructor Details

    • DescribeCacheClustersRequest

      public DescribeCacheClustersRequest()
  • Method Details

    • 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.
    • 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.
    • 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.

      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:
      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 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.
    • 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.
    • withMarker

      public DescribeCacheClustersRequest 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.

      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:
      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.
    • 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:
    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • 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: