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

Interface DescribeSnapshotsRequest.Builder

All Superinterfaces:

CopyableBuilder<DescribeSnapshotsRequest.Builder,DescribeSnapshotsRequest>, SdkBuilder<DescribeSnapshotsRequest.Builder,DescribeSnapshotsRequest>

Enclosing class:

DescribeSnapshotsRequest

public static interface DescribeSnapshotsRequest.Builder
extends CopyableBuilder<DescribeSnapshotsRequest.Builder,DescribeSnapshotsRequest>

Method Summary

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	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 to system, the output shows snapshots that were automatically created by ElastiCache.

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

copy

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

apply, build

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 cache cluster are described.

Parameters:

cacheClusterId - A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with that specific cache 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 to user the output shows snapshots that were manually created. If omitted, the output shows both automatically and manually created snapshots.

Parameters:

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.

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 by MaxRecords.

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

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.