Package software.amazon.awssdk.services.elasticache.model

Class DescribeCacheClustersRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.elasticache.model.ElastiCacheRequest

software.amazon.awssdk.services.elasticache.model.DescribeCacheClustersRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeCacheClustersRequest.Builder,DescribeCacheClustersRequest>

@Generated("software.amazon.awssdk:codegen")
public final class DescribeCacheClustersRequest
extends ElastiCacheRequest
implements ToCopyableBuilder<DescribeCacheClustersRequest.Builder,DescribeCacheClustersRequest>

Represents the input of a DescribeCacheClusters operation.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeCacheClustersRequest.Builder

Method Summary

Modifier and Type	Method	Description
static DescribeCacheClustersRequest.Builder	builder()
String	cacheClusterId()	The user-supplied cluster identifier.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	marker()	An optional marker returned from a prior request.
Integer	maxRecords()	The maximum number of records to include in the response.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeCacheClustersRequest.Builder>	serializableBuilderClass()
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.
Boolean	showCacheNodeInfo()	An optional flag that can be included in the DescribeCacheCluster request to retrieve information about the individual cache nodes.
DescribeCacheClustersRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

cacheClusterId

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

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.

maxRecords

public final 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:

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.

marker

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

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.

showCacheNodeInfo

public final Boolean showCacheNodeInfo()

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.

showCacheClustersNotInReplicationGroups

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

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.

toBuilder

public DescribeCacheClustersRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeCacheClustersRequest.Builder,DescribeCacheClustersRequest>

Specified by:

toBuilder in class ElastiCacheRequest

builder

public static DescribeCacheClustersRequest.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeCacheClustersRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo