Interface ListClusterSnapshotsRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<ListClusterSnapshotsRequest.Builder,
,ListClusterSnapshotsRequest> DocDbElasticRequest.Builder
,SdkBuilder<ListClusterSnapshotsRequest.Builder,
,ListClusterSnapshotsRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
ListClusterSnapshotsRequest
-
Method Summary
Modifier and TypeMethodDescriptionclusterArn
(String clusterArn) The ARN identifier of the elastic cluster.maxResults
(Integer maxResults) The maximum number of elastic cluster snapshot results to receive in the response.A pagination token provided by a previous request.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.snapshotType
(String snapshotType) The type of cluster snapshots to be returned.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.docdbelastic.model.DocDbElasticRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
clusterArn
The ARN identifier of the elastic cluster.
- Parameters:
clusterArn
- The ARN identifier of the elastic cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
maxResults
The maximum number of elastic cluster snapshot results to receive in the response.
- Parameters:
maxResults
- The maximum number of elastic cluster snapshot results to receive in the response.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
nextToken
A pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond this token, up to the value specified by
max-results
.If there is no more data in the responce, the
nextToken
will not be returned.- Parameters:
nextToken
- A pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond this token, up to the value specified bymax-results
.If there is no more data in the responce, the
nextToken
will not be returned.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
snapshotType
The type of cluster snapshots to be returned. You can specify one of the following values:
-
automated
- Return all cluster snapshots that Amazon DocumentDB has automatically created for your Amazon Web Services account. -
manual
- Return all cluster snapshots that you have manually created for your Amazon Web Services account.
- Parameters:
snapshotType
- The type of cluster snapshots to be returned. You can specify one of the following values:-
automated
- Return all cluster snapshots that Amazon DocumentDB has automatically created for your Amazon Web Services account. -
manual
- Return all cluster snapshots that you have manually created for your Amazon Web Services account.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
overrideConfiguration
ListClusterSnapshotsRequest.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
ListClusterSnapshotsRequest.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.
-