DescribeCacheClustersRequest

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

すべての実装されたインタフェース:

java.io.Serializable
```
public class DescribeCacheClustersRequest
extends AmazonWebServiceRequest
implements java.io.Serializable
```
Container for the parameters to 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.

Cluster information will be returned by default. An optional ShowDetails flag can be used to retrieve detailed information about the Cache Nodes associated with the Cache Cluster. 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.

While adding Cache Nodes, node endpoint information and creation time for the additional nodes will not be displayed until they are completely provisioned. The cluster lifecycle tells the customer when new nodes are AVAILABLE.

While removing existing Cache Nodes from an cluster, endpoint information for the removed nodes will not be displayed.

DescribeCacheClusters supports pagination.

関連項目:
AmazonElastiCache.describeCacheClusters(DescribeCacheClustersRequest), 直列化された形式

コンストラクタの概要

コンストラクタ
コンストラクタと説明

DescribeCacheClustersRequest()
Default constructor for a new DescribeCacheClustersRequest object.

コンストラクタ
コンストラクタと説明
`DescribeCacheClustersRequest()` Default constructor for a new DescribeCacheClustersRequest object.

メソッドの概要

メソッド
修飾子とタイプ	メソッドと説明
`boolean`	`equals(java.lang.Object obj)`
`java.lang.String`	`getCacheClusterId()` The user-supplied cluster identifier.
`java.lang.String`	`getMarker()` An optional marker provided in the previous DescribeCacheClusters request.
`java.lang.Integer`	`getMaxRecords()` The maximum number of records to include in the response.
`java.lang.Boolean`	`getShowCacheNodeInfo()` An optional flag that can be included in the DescribeCacheCluster request to retrieve Cache Nodes information.
`int`	`hashCode()`
`java.lang.Boolean`	`isShowCacheNodeInfo()` An optional flag that can be included in the DescribeCacheCluster request to retrieve Cache Nodes information.
`void`	`setCacheClusterId(java.lang.String cacheClusterId)` The user-supplied cluster identifier.
`void`	`setMarker(java.lang.String marker)` An optional marker provided in the previous DescribeCacheClusters request.
`void`	`setMaxRecords(java.lang.Integer maxRecords)` The maximum number of records to include in the response.
`void`	`setShowCacheNodeInfo(java.lang.Boolean showCacheNodeInfo)` An optional flag that can be included in the DescribeCacheCluster request to retrieve Cache Nodes information.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`DescribeCacheClustersRequest`	`withCacheClusterId(java.lang.String cacheClusterId)` The user-supplied cluster identifier.
`DescribeCacheClustersRequest`	`withMarker(java.lang.String marker)` An optional marker provided in the previous DescribeCacheClusters request.
`DescribeCacheClustersRequest`	`withMaxRecords(java.lang.Integer maxRecords)` The maximum number of records to include in the response.
`DescribeCacheClustersRequest`	`withShowCacheNodeInfo(java.lang.Boolean showCacheNodeInfo)` An optional flag that can be included in the DescribeCacheCluster request to retrieve Cache Nodes information.

クラスから継承されたメソッド com.amazonaws.AmazonWebServiceRequest
copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, setRequestCredentials

クラスから継承されたメソッド java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- コンストラクタの詳細
  - 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.
- メソッドの詳細
  - getCacheClusterId
```
public java.lang.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.
    
    戻り値:
    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(java.lang.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.
    
    パラメータ:
    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(java.lang.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.
    
    パラメータ:
    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.
  - getMaxRecords
```
public java.lang.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.
    Default: 100
    Constraints: minimum 20, maximum 100
    
    戻り値:
    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.
    Default: 100
    Constraints: minimum 20, maximum 100
  - setMaxRecords
```
public void setMaxRecords(java.lang.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.
    Default: 100
    Constraints: minimum 20, maximum 100
    
    パラメータ:
    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.
    Default: 100
    Constraints: minimum 20, maximum 100
  - withMaxRecords
```
public DescribeCacheClustersRequest withMaxRecords(java.lang.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.
    Default: 100
    Constraints: minimum 20, maximum 100
    Returns a reference to this object so that method calls can be chained together.
    
    パラメータ:
    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.
    Default: 100
    Constraints: minimum 20, maximum 100
  - getMarker
```
public java.lang.String getMarker()
```
    An optional marker provided in the previous DescribeCacheClusters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
    
    戻り値:
    An optional marker provided in the previous DescribeCacheClusters 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(java.lang.String marker)
```
    An optional marker provided in the previous DescribeCacheClusters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
    
    パラメータ:
    marker - An optional marker provided in the previous DescribeCacheClusters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
  - withMarker
```
public DescribeCacheClustersRequest withMarker(java.lang.String marker)
```
    An optional marker provided in the previous DescribeCacheClusters 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.
    
    パラメータ:
    marker - An optional marker provided in the previous DescribeCacheClusters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
  - isShowCacheNodeInfo
```
public java.lang.Boolean isShowCacheNodeInfo()
```
    An optional flag that can be included in the DescribeCacheCluster request to retrieve Cache Nodes information.
    
    戻り値:
    An optional flag that can be included in the DescribeCacheCluster request to retrieve Cache Nodes information.
  - setShowCacheNodeInfo
```
public void setShowCacheNodeInfo(java.lang.Boolean showCacheNodeInfo)
```
    An optional flag that can be included in the DescribeCacheCluster request to retrieve Cache Nodes information.
    
    パラメータ:
    showCacheNodeInfo - An optional flag that can be included in the DescribeCacheCluster request to retrieve Cache Nodes information.
  - withShowCacheNodeInfo
```
public DescribeCacheClustersRequest withShowCacheNodeInfo(java.lang.Boolean showCacheNodeInfo)
```
    An optional flag that can be included in the DescribeCacheCluster request to retrieve Cache Nodes information.
    Returns a reference to this object so that method calls can be chained together.
    
    パラメータ:
    showCacheNodeInfo - An optional flag that can be included in the DescribeCacheCluster request to retrieve Cache Nodes information.
  - getShowCacheNodeInfo
```
public java.lang.Boolean getShowCacheNodeInfo()
```
    An optional flag that can be included in the DescribeCacheCluster request to retrieve Cache Nodes information.
    
    戻り値:
    An optional flag that can be included in the DescribeCacheCluster request to retrieve Cache Nodes information.
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    オーバーライド:
    
    toString クラス内 java.lang.Object
    
    戻り値:
    A string representation of this object.
    関連項目:
    Object.toString()
  - hashCode
```
public int hashCode()
```
    オーバーライド:
    
    hashCode クラス内 java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    オーバーライド:
    
    equals クラス内 java.lang.Object

クラス DescribeCacheClustersRequest

コンストラクタの概要

メソッドの概要

クラスから継承されたメソッド com.amazonaws.AmazonWebServiceRequest

クラスから継承されたメソッド java.lang.Object

コンストラクタの詳細

DescribeCacheClustersRequest

メソッドの詳細

getCacheClusterId

setCacheClusterId

withCacheClusterId

getMaxRecords

setMaxRecords

withMaxRecords

getMarker

setMarker

withMarker

isShowCacheNodeInfo

setShowCacheNodeInfo

withShowCacheNodeInfo

getShowCacheNodeInfo

toString

hashCode

equals