@Generated(value="software.amazon.awssdk:codegen") public class DescribeSnapshotsRequest extends ElastiCacheRequest implements ToCopyableBuilder<DescribeSnapshotsRequest.Builder,DescribeSnapshotsRequest>
Represents the input of a DescribeSnapshotsMessage
operation.
Modifier and Type | Class and Description |
---|---|
static interface |
DescribeSnapshotsRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static DescribeSnapshotsRequest.Builder |
builder() |
String |
cacheClusterId()
A user-supplied cluster identifier.
|
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
int |
hashCode() |
String |
marker()
An optional marker returned from a prior request.
|
Integer |
maxRecords()
The maximum number of records to include in the response.
|
String |
replicationGroupId()
A user-supplied replication group identifier.
|
static Class<? extends DescribeSnapshotsRequest.Builder> |
serializableBuilderClass() |
Boolean |
showNodeGroupConfig()
A Boolean value which if true, the node group (shard) configuration is included in the snapshot description.
|
String |
snapshotName()
A user-supplied name of the snapshot.
|
String |
snapshotSource()
If set to
system , the output shows snapshots that were automatically created by ElastiCache. |
DescribeSnapshotsRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
requestOverrideConfig
copy
public String replicationGroupId()
A user-supplied replication group identifier. If this parameter is specified, only snapshots associated with that specific replication group are described.
public String cacheClusterId()
A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with that specific cluster are described.
public String snapshotName()
A user-supplied name of the snapshot. If this parameter is specified, only this snapshot are described.
public String snapshotSource()
If set to system
, the output shows snapshots that were automatically created by ElastiCache. If set
to user
the output shows snapshots that were manually created. If omitted, the output shows both
automatically and manually created snapshots.
system
, the output shows snapshots that were automatically created by ElastiCache.
If set to user
the output shows snapshots that were manually created. If omitted, the output
shows both automatically and manually created snapshots.public 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
.
MaxRecords
.public 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: 50
Constraints: minimum 20; maximum 50.
MaxRecords
value, a marker is included in the response so that the remaining results can be
retrieved.
Default: 50
Constraints: minimum 20; maximum 50.
public Boolean showNodeGroupConfig()
A Boolean value which if true, the node group (shard) configuration is included in the snapshot description.
public DescribeSnapshotsRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<DescribeSnapshotsRequest.Builder,DescribeSnapshotsRequest>
toBuilder
in class ElastiCacheRequest
public static DescribeSnapshotsRequest.Builder builder()
public static Class<? extends DescribeSnapshotsRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. 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, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.