software.amazon.awssdk.services.rds.model

Class DescribeDbClusterEndpointsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.rds.model.RdsRequest

software.amazon.awssdk.services.rds.model.DescribeDbClusterEndpointsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeDbClusterEndpointsRequest.Builder,DescribeDbClusterEndpointsRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class DescribeDbClusterEndpointsRequest
extends RdsRequest
implements ToCopyableBuilder<DescribeDbClusterEndpointsRequest.Builder,DescribeDbClusterEndpointsRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeDbClusterEndpointsRequest.Builder

Method Summary

Modifier and Type	Method and Description
static DescribeDbClusterEndpointsRequest.Builder	builder()
String	dbClusterEndpointIdentifier() The identifier of the endpoint to describe.
String	dbClusterIdentifier() The DB cluster identifier of the DB cluster associated with the endpoint.
boolean	equals(Object obj)
List<Filter>	filters() A set of name-value pairs that define which endpoints to include in the output.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
String	marker() An optional pagination token provided by a previous DescribeDBClusterEndpoints request.
Integer	maxRecords() The maximum number of records to include in the response.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeDbClusterEndpointsRequest.Builder>	serializableBuilderClass()
DescribeDbClusterEndpointsRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

dbClusterIdentifier

public String dbClusterIdentifier()

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

Returns:

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

dbClusterEndpointIdentifier

public String dbClusterEndpointIdentifier()

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

Returns:

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

filters

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

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.

maxRecords

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

Returns:

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.

marker

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

Returns:

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.

toBuilder

public DescribeDbClusterEndpointsRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeDbClusterEndpointsRequest.Builder,DescribeDbClusterEndpointsRequest>

Specified by:

toBuilder in class RdsRequest

Returns:

a builder for type T

builder

public static DescribeDbClusterEndpointsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeDbClusterEndpointsRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.