Interface DescribeSnapshotsRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<DescribeSnapshotsRequest.Builder,
,DescribeSnapshotsRequest> ElastiCacheRequest.Builder
,SdkBuilder<DescribeSnapshotsRequest.Builder,
,DescribeSnapshotsRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
DescribeSnapshotsRequest
-
Method Summary
Modifier and TypeMethodDescriptioncacheClusterId
(String cacheClusterId) A user-supplied cluster identifier.An optional marker returned from a prior request.maxRecords
(Integer maxRecords) The maximum number of records to include in the response.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.replicationGroupId
(String replicationGroupId) A user-supplied replication group identifier.showNodeGroupConfig
(Boolean showNodeGroupConfig) A Boolean value which if true, the node group (shard) configuration is included in the snapshot description.snapshotName
(String snapshotName) A user-supplied name of the snapshot.snapshotSource
(String snapshotSource) If set tosystem
, the output shows snapshots that were automatically created by ElastiCache.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.elasticache.model.ElastiCacheRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
Method Details
-
replicationGroupId
A user-supplied replication group identifier. If this parameter is specified, only snapshots associated with that specific replication group are described.
- Parameters:
replicationGroupId
- A user-supplied replication group identifier. If this parameter is specified, only snapshots associated with that specific replication group are described.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
cacheClusterId
A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with that specific cluster are described.
- Parameters:
cacheClusterId
- A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with that specific cluster are described.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
snapshotName
A user-supplied name of the snapshot. If this parameter is specified, only this snapshot are described.
- Parameters:
snapshotName
- A user-supplied name of the snapshot. If this parameter is specified, only this snapshot are described.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
snapshotSource
If set to
system
, the output shows snapshots that were automatically created by ElastiCache. If set touser
the output shows snapshots that were manually created. If omitted, the output shows both automatically and manually created snapshots.- Parameters:
snapshotSource
- If set tosystem
, the output shows snapshots that were automatically created by ElastiCache. If set touser
the output shows snapshots that were manually created. If omitted, the output shows both automatically and manually created snapshots.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
.- Parameters:
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 byMaxRecords
.- Returns:
- 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 can be retrieved.Default: 50
Constraints: minimum 20; maximum 50.
- Parameters:
maxRecords
- The maximum number of records to include in the response. If more records exist than the specifiedMaxRecords
value, a marker is included in the response so that the remaining results can be retrieved.Default: 50
Constraints: minimum 20; maximum 50.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
showNodeGroupConfig
A Boolean value which if true, the node group (shard) configuration is included in the snapshot description.
- Parameters:
showNodeGroupConfig
- A Boolean value which if true, the node group (shard) configuration is included in the snapshot description.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
DescribeSnapshotsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
DescribeSnapshotsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-