software.amazon.awssdk.services.memorydb.model

Interface DescribeSnapshotsRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<DescribeSnapshotsRequest.Builder,DescribeSnapshotsRequest>, MemoryDbRequest.Builder, SdkBuilder<DescribeSnapshotsRequest.Builder,DescribeSnapshotsRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

DescribeSnapshotsRequest

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

Method Summary

Modifier and Type	Method and Description
DescribeSnapshotsRequest.Builder	clusterName(String clusterName) A user-supplied cluster identifier.
DescribeSnapshotsRequest.Builder	maxResults(Integer maxResults) The maximum number of records to include in the response.
DescribeSnapshotsRequest.Builder	nextToken(String nextToken) An optional argument to pass in case the total number of records exceeds the value of MaxResults.
DescribeSnapshotsRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
DescribeSnapshotsRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
DescribeSnapshotsRequest.Builder	showDetail(Boolean showDetail) A Boolean value which if true, the shard configuration is included in the snapshot description.
DescribeSnapshotsRequest.Builder	snapshotName(String snapshotName) A user-supplied name of the snapshot.
DescribeSnapshotsRequest.Builder	source(String source) If set to system, the output shows snapshots that were automatically created by MemoryDB.

Methods inherited from interface software.amazon.awssdk.services.memorydb.model.MemoryDbRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

clusterName

DescribeSnapshotsRequest.Builder clusterName(String clusterName)

A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with that specific cluster are described.

Parameters:

clusterName - 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 named snapshot is described.

Parameters:

snapshotName - A user-supplied name of the snapshot. If this parameter is specified, only this named snapshot is described.

Returns:

Returns a reference to this object so that method calls can be chained together.

source

DescribeSnapshotsRequest.Builder source(String source)

If set to system, the output shows snapshots that were automatically created by MemoryDB. If set to user the output shows snapshots that were manually created. If omitted, the output shows both automatically and manually created snapshots.

Parameters:

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

nextToken

DescribeSnapshotsRequest.Builder nextToken(String nextToken)

An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

Parameters:

nextToken - An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

Returns:

Returns a reference to this object so that method calls can be chained together.

maxResults

DescribeSnapshotsRequest.Builder maxResults(Integer maxResults)

The maximum number of records to include in the response. If more records exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

Parameters:

maxResults - The maximum number of records to include in the response. If more records exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

Returns:

Returns a reference to this object so that method calls can be chained together.

showDetail

DescribeSnapshotsRequest.Builder showDetail(Boolean showDetail)

A Boolean value which if true, the shard configuration is included in the snapshot description.

Parameters:

showDetail - A Boolean value which if true, the 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 interface AwsRequest.Builder

overrideConfiguration

DescribeSnapshotsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder