Class DescribeCacheClustersRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<DescribeCacheClustersRequest.Builder,
DescribeCacheClustersRequest>
Represents the input of a DescribeCacheClusters
operation.
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
The user-supplied cluster identifier.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final String
marker()
An optional marker returned from a prior request.final Integer
The maximum number of records to include in the response.static Class
<? extends DescribeCacheClustersRequest.Builder> final Boolean
An optional flag that can be included in theDescribeCacheCluster
request to show only nodes (API/CLI: clusters) that are not members of a replication group.final Boolean
An optional flag that can be included in theDescribeCacheCluster
request to retrieve information about the individual cache nodes.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
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
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
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
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
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<DescribeCacheClustersRequest.Builder,
DescribeCacheClustersRequest> - Specified by:
toBuilder
in classElastiCacheRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-