software.amazon.awssdk.services.rds.model

Interface DescribeDbClusterEndpointsRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<DescribeDbClusterEndpointsRequest.Builder,DescribeDbClusterEndpointsRequest>, RdsRequest.Builder, SdkBuilder<DescribeDbClusterEndpointsRequest.Builder,DescribeDbClusterEndpointsRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

DescribeDbClusterEndpointsRequest

public static interface DescribeDbClusterEndpointsRequest.Builder
extends RdsRequest.Builder, SdkPojo, CopyableBuilder<DescribeDbClusterEndpointsRequest.Builder,DescribeDbClusterEndpointsRequest>

Method Summary

Modifier and Type	Method and Description
DescribeDbClusterEndpointsRequest.Builder	dbClusterEndpointIdentifier(String dbClusterEndpointIdentifier) The identifier of the endpoint to describe.
DescribeDbClusterEndpointsRequest.Builder	dbClusterIdentifier(String dbClusterIdentifier) The DB cluster identifier of the DB cluster associated with the endpoint.
DescribeDbClusterEndpointsRequest.Builder	filters(Collection<Filter> filters) A set of name-value pairs that define which endpoints to include in the output.
DescribeDbClusterEndpointsRequest.Builder	filters(Consumer<Filter.Builder>... filters) A set of name-value pairs that define which endpoints to include in the output.
DescribeDbClusterEndpointsRequest.Builder	filters(Filter... filters) A set of name-value pairs that define which endpoints to include in the output.
DescribeDbClusterEndpointsRequest.Builder	marker(String marker) An optional pagination token provided by a previous DescribeDBClusterEndpoints request.
DescribeDbClusterEndpointsRequest.Builder	maxRecords(Integer maxRecords) The maximum number of records to include in the response.
DescribeDbClusterEndpointsRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
DescribeDbClusterEndpointsRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.

Methods inherited from interface software.amazon.awssdk.services.rds.model.RdsRequest.Builder

build

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

overrideConfiguration

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

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

DescribeDbClusterEndpointsRequest.Builder dbClusterIdentifier(String dbClusterIdentifier)

The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.

Parameters:

dbClusterIdentifier - The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.

Returns:

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

dbClusterEndpointIdentifier

DescribeDbClusterEndpointsRequest.Builder dbClusterEndpointIdentifier(String dbClusterEndpointIdentifier)

The identifier of the endpoint to describe. This parameter is stored as a lowercase string.

Parameters:

dbClusterEndpointIdentifier - The identifier of the endpoint to describe. This parameter is stored as a lowercase string.

Returns:

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

filters

DescribeDbClusterEndpointsRequest.Builder filters(Collection<Filter> filters)

A set of name-value pairs that define which endpoints to include in the output. The filters are specified as name-value pairs, in the format Name=endpoint_type,Values=endpoint_type1,endpoint_type2,.... Name can be one of: db-cluster-endpoint-type, db-cluster-endpoint-custom-type, db-cluster-endpoint-id, db-cluster-endpoint-status. Values for the db-cluster-endpoint-type filter can be one or more of: reader, writer, custom. Values for the db-cluster-endpoint-custom-type filter can be one or more of: reader, any. Values for the db-cluster-endpoint-status filter can be one or more of: available, creating, deleting, modifying.

Parameters:

filters - A set of name-value pairs that define which endpoints to include in the output. The filters are specified as name-value pairs, in the format Name=endpoint_type,Values=endpoint_type1,endpoint_type2,.... Name can be one of: db-cluster-endpoint-type, db-cluster-endpoint-custom-type, db-cluster-endpoint-id, db-cluster-endpoint-status. Values for the db-cluster-endpoint-type filter can be one or more of: reader, writer, custom. Values for the db-cluster-endpoint-custom-type filter can be one or more of: reader, any. Values for the db-cluster-endpoint-status filter can be one or more of: available, creating, deleting, modifying.

Returns:

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

filters

DescribeDbClusterEndpointsRequest.Builder filters(Filter... filters)

A set of name-value pairs that define which endpoints to include in the output. The filters are specified as name-value pairs, in the format Name=endpoint_type,Values=endpoint_type1,endpoint_type2,.... Name can be one of: db-cluster-endpoint-type, db-cluster-endpoint-custom-type, db-cluster-endpoint-id, db-cluster-endpoint-status. Values for the db-cluster-endpoint-type filter can be one or more of: reader, writer, custom. Values for the db-cluster-endpoint-custom-type filter can be one or more of: reader, any. Values for the db-cluster-endpoint-status filter can be one or more of: available, creating, deleting, modifying.

Parameters:

filters - A set of name-value pairs that define which endpoints to include in the output. The filters are specified as name-value pairs, in the format Name=endpoint_type,Values=endpoint_type1,endpoint_type2,.... Name can be one of: db-cluster-endpoint-type, db-cluster-endpoint-custom-type, db-cluster-endpoint-id, db-cluster-endpoint-status. Values for the db-cluster-endpoint-type filter can be one or more of: reader, writer, custom. Values for the db-cluster-endpoint-custom-type filter can be one or more of: reader, any. Values for the db-cluster-endpoint-status filter can be one or more of: available, creating, deleting, modifying.

Returns:

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

filters

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

A set of name-value pairs that define which endpoints to include in the output. The filters are specified as name-value pairs, in the format Name=endpoint_type,Values=endpoint_type1,endpoint_type2,.... Name can be one of: db-cluster-endpoint-type, db-cluster-endpoint-custom-type, db-cluster-endpoint-id, db-cluster-endpoint-status. Values for the db-cluster-endpoint-type filter can be one or more of: reader, writer, custom. Values for the db-cluster-endpoint-custom-type filter can be one or more of: reader, any. Values for the db-cluster-endpoint-status filter can be one or more of: available, creating, deleting, modifying.

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

DescribeDbClusterEndpointsRequest.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 called a 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 called a 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

DescribeDbClusterEndpointsRequest.Builder marker(String marker)

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

DescribeDbClusterEndpointsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

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

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.