Interface DescribeSnapshotsRequest.Builder
-
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<DescribeSnapshotsRequest.Builder,DescribeSnapshotsRequest>
,ElastiCacheRequest.Builder
,SdkBuilder<DescribeSnapshotsRequest.Builder,DescribeSnapshotsRequest>
,SdkPojo
,SdkRequest.Builder
- Enclosing class:
- DescribeSnapshotsRequest
public static interface DescribeSnapshotsRequest.Builder extends ElastiCacheRequest.Builder, SdkPojo, CopyableBuilder<DescribeSnapshotsRequest.Builder,DescribeSnapshotsRequest>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description DescribeSnapshotsRequest.Builder
cacheClusterId(String cacheClusterId)
A user-supplied cluster identifier.DescribeSnapshotsRequest.Builder
marker(String marker)
An optional marker returned from a prior request.DescribeSnapshotsRequest.Builder
maxRecords(Integer maxRecords)
The maximum number of records to include in the response.DescribeSnapshotsRequest.Builder
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
DescribeSnapshotsRequest.Builder
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
DescribeSnapshotsRequest.Builder
replicationGroupId(String replicationGroupId)
A user-supplied replication group identifier.DescribeSnapshotsRequest.Builder
showNodeGroupConfig(Boolean showNodeGroupConfig)
A Boolean value which if true, the node group (shard) configuration is included in the snapshot description.DescribeSnapshotsRequest.Builder
snapshotName(String snapshotName)
A user-supplied name of the snapshot.DescribeSnapshotsRequest.Builder
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 Detail
-
replicationGroupId
DescribeSnapshotsRequest.Builder replicationGroupId(String 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
DescribeSnapshotsRequest.Builder cacheClusterId(String 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
DescribeSnapshotsRequest.Builder snapshotName(String 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
DescribeSnapshotsRequest.Builder snapshotSource(String 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
DescribeSnapshotsRequest.Builder marker(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
.- 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
DescribeSnapshotsRequest.Builder maxRecords(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.
- 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
DescribeSnapshotsRequest.Builder showNodeGroupConfig(Boolean 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)
- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
-
overrideConfiguration
DescribeSnapshotsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
-
-