Package software.amazon.awssdk.services.rds.model

Class DescribeDbClusterAutomatedBackupsRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeDbClusterAutomatedBackupsRequest.Builder,DescribeDbClusterAutomatedBackupsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeDbClusterAutomatedBackupsRequest.Builder

Method Summary

Modifier and Type	Method	Description
static DescribeDbClusterAutomatedBackupsRequest.Builder	builder()
String	dbClusterIdentifier()	(Optional) The user-supplied DB cluster identifier.
String	dbClusterResourceId()	The resource ID of the DB cluster that is the source of the automated backup.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<Filter>	filters()	A filter that specifies which resources to return based on status.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFilters()	For responses, this returns true if the service returned a value for the Filters property.
int	hashCode()
String	marker()	The pagination token provided in the previous request.
Integer	maxRecords()	The maximum number of records to include in the response.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeDbClusterAutomatedBackupsRequest.Builder>	serializableBuilderClass()
DescribeDbClusterAutomatedBackupsRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

dbClusterResourceId

public final String dbClusterResourceId()

The resource ID of the DB cluster that is the source of the automated backup. This parameter isn't case-sensitive.

Returns:

The resource ID of the DB cluster that is the source of the automated backup. This parameter isn't case-sensitive.

dbClusterIdentifier

public final String dbClusterIdentifier()

(Optional) The user-supplied DB cluster identifier. If this parameter is specified, it must match the identifier of an existing DB cluster. It returns information from the specific DB cluster's automated backup. This parameter isn't case-sensitive.

Returns:

(Optional) The user-supplied DB cluster identifier. If this parameter is specified, it must match the identifier of an existing DB cluster. It returns information from the specific DB cluster's automated backup. This parameter isn't case-sensitive.

hasFilters

public final boolean hasFilters()

For responses, this returns true if the service returned a value for the Filters property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

filters

public final List<Filter> filters()

A filter that specifies which resources to return based on status.

Supported filters are the following:

• status

  • retained - Automated backups for deleted clusters and after backup replication is stopped.

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

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

Returns all resources by default. The status for each resource is specified in the response.

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

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasFilters() method.

Returns:

A filter that specifies which resources to return based on status.

Supported filters are the following:

• status

  • retained - Automated backups for deleted clusters and after backup replication is stopped.

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

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

Returns all resources by default. The status for each resource is specified in the response.

maxRecords

public final 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 you can retrieve the remaining results.

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 you can retrieve the remaining results.

marker

public final String marker()

The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords.

Returns:

The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords.

toBuilder

public DescribeDbClusterAutomatedBackupsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeDbClusterAutomatedBackupsRequest.Builder,DescribeDbClusterAutomatedBackupsRequest>

Specified by:

toBuilder in class RdsRequest

builder

public static DescribeDbClusterAutomatedBackupsRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

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

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo