software.amazon.awssdk.services.rds.model

Class DescribeDbClusterBacktracksRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeDbClusterBacktracksRequest.Builder,DescribeDbClusterBacktracksRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeDbClusterBacktracksRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	backtrackIdentifier() If specified, this value is the backtrack identifier of the backtrack to be described.
static DescribeDbClusterBacktracksRequest.Builder	builder()
String	dbClusterIdentifier() The DB cluster identifier of the DB cluster to be described.
boolean	equals(Object obj)
List<Filter>	filters() A filter that specifies one or more DB clusters to describe.
<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 DescribeDBClusterBacktracks request.
Integer	maxRecords() The maximum number of records to include in the response.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeDbClusterBacktracksRequest.Builder>	serializableBuilderClass()
DescribeDbClusterBacktracksRequest.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 to be described. This parameter is stored as a lowercase string.

Constraints:

• Must contain from 1 to 63 alphanumeric characters or hyphens.

• First character must be a letter.

• Can't end with a hyphen or contain two consecutive hyphens.

Example: my-cluster1

Returns:

The DB cluster identifier of the DB cluster to be described. This parameter is stored as a lowercase string.

Constraints:

• Must contain from 1 to 63 alphanumeric characters or hyphens.

• First character must be a letter.

• Can't end with a hyphen or contain two consecutive hyphens.

Example: my-cluster1

backtrackIdentifier

public String backtrackIdentifier()

If specified, this value is the backtrack identifier of the backtrack to be described.

Constraints:

• Must contain a valid universally unique identifier (UUID). For more information about UUIDs, see A Universally Unique Identifier (UUID) URN Namespace.

Example: 123e4567-e89b-12d3-a456-426655440000

Returns:

If specified, this value is the backtrack identifier of the backtrack to be described.

Constraints:

• Must contain a valid universally unique identifier (UUID). For more information about UUIDs, see A Universally Unique Identifier (UUID) URN Namespace.

Example: 123e4567-e89b-12d3-a456-426655440000

filters

public List<Filter> filters()

A filter that specifies one or more DB clusters to describe. Supported filters include the following:

• db-cluster-backtrack-id - Accepts backtrack identifiers. The results list includes information about only the backtracks identified by these identifiers.

• db-cluster-backtrack-status - Accepts any of the following backtrack status values:

  • applying

  • completed

  • failed

  • pending

  The results list includes information about only the backtracks identified by these values. For more information about backtrack status values, see DBClusterBacktrack.

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

Returns:

A filter that specifies one or more DB clusters to describe. Supported filters include the following:

• db-cluster-backtrack-id - Accepts backtrack identifiers. The results list includes information about only the backtracks identified by these identifiers.

• db-cluster-backtrack-status - Accepts any of the following backtrack status values:

  • applying

  • completed

  • failed

  • pending

  The results list includes information about only the backtracks identified by these values. For more information about backtrack status values, see DBClusterBacktrack.

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 DescribeDBClusterBacktracks 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 DescribeDBClusterBacktracks request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

toBuilder

public DescribeDbClusterBacktracksRequest.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<DescribeDbClusterBacktracksRequest.Builder,DescribeDbClusterBacktracksRequest>

Specified by:

toBuilder in class RdsRequest

Returns:

a builder for type T

builder

public static DescribeDbClusterBacktracksRequest.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeDbClusterBacktracksRequest.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.