software.amazon.awssdk.services.docdb.model

Interface DescribeDbClustersRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<DescribeDbClustersRequest.Builder,DescribeDbClustersRequest>, DocDbRequest.Builder, SdkBuilder<DescribeDbClustersRequest.Builder,DescribeDbClustersRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

DescribeDbClustersRequest

public static interface DescribeDbClustersRequest.Builder
extends DocDbRequest.Builder, SdkPojo, CopyableBuilder<DescribeDbClustersRequest.Builder,DescribeDbClustersRequest>

Method Summary

Modifier and Type	Method and Description
DescribeDbClustersRequest.Builder	dbClusterIdentifier(String dbClusterIdentifier) The user-provided cluster identifier.
DescribeDbClustersRequest.Builder	filters(Collection<Filter> filters) A filter that specifies one or more clusters to describe.
DescribeDbClustersRequest.Builder	filters(Consumer<Filter.Builder>... filters) A filter that specifies one or more clusters to describe.
DescribeDbClustersRequest.Builder	filters(Filter... filters) A filter that specifies one or more clusters to describe.
DescribeDbClustersRequest.Builder	marker(String marker) An optional pagination token provided by a previous request.
DescribeDbClustersRequest.Builder	maxRecords(Integer maxRecords) The maximum number of records to include in the response.
DescribeDbClustersRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
DescribeDbClustersRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Methods inherited from interface software.amazon.awssdk.services.docdb.model.DocDbRequest.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

dbClusterIdentifier

DescribeDbClustersRequest.Builder dbClusterIdentifier(String dbClusterIdentifier)

The user-provided cluster identifier. If this parameter is specified, information from only the specific cluster is returned. This parameter isn't case sensitive.

Constraints:

• If provided, must match an existing DBClusterIdentifier.

Parameters:

dbClusterIdentifier - The user-provided cluster identifier. If this parameter is specified, information from only the specific cluster is returned. This parameter isn't case sensitive.

Constraints:

• If provided, must match an existing DBClusterIdentifier.

Returns:

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

filters

DescribeDbClustersRequest.Builder filters(Collection<Filter> filters)

A filter that specifies one or more clusters to describe.

Supported filters:

• db-cluster-id - Accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list only includes information about the clusters identified by these ARNs.

Parameters:

filters - A filter that specifies one or more clusters to describe.

Supported filters:

• db-cluster-id - Accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list only includes information about the clusters identified by these ARNs.

Returns:

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

filters

DescribeDbClustersRequest.Builder filters(Filter... filters)

A filter that specifies one or more clusters to describe.

Supported filters:

• db-cluster-id - Accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list only includes information about the clusters identified by these ARNs.

Parameters:

filters - A filter that specifies one or more clusters to describe.

Supported filters:

• db-cluster-id - Accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list only includes information about the clusters identified by these ARNs.

Returns:

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

filters

DescribeDbClustersRequest.Builder filters(Consumer<Filter.Builder>... filters)

A filter that specifies one or more clusters to describe.

Supported filters:

• db-cluster-id - Accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list only includes information about the clusters identified by these ARNs.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #filters(List).

Parameters:

filters - a consumer that will call methods on List.Builder

Returns:

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

See Also:

#filters(List)

maxRecords

DescribeDbClustersRequest.Builder maxRecords(Integer maxRecords)

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

Default: 100

Constraints: Minimum 20, maximum 100.

Parameters:

maxRecords - The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

Returns:

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

marker

DescribeDbClustersRequest.Builder marker(String marker)

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Parameters:

marker - An optional pagination token provided by a previous request. 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.

overrideConfiguration

DescribeDbClustersRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

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

Specified by:

overrideConfiguration in interface AwsRequest.Builder