software.amazon.awssdk.services.rds.model

Class DescribeDbInstanceAutomatedBackupsRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeDbInstanceAutomatedBackupsRequest.Builder,DescribeDbInstanceAutomatedBackupsRequest>

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

Parameter input for DescribeDBInstanceAutomatedBackups.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeDbInstanceAutomatedBackupsRequest.Builder

Method Summary

Modifier and Type	Method and Description
static DescribeDbInstanceAutomatedBackupsRequest.Builder	builder()
String	dbInstanceIdentifier() (Optional) The user-supplied instance identifier.
String	dbiResourceId() The resource ID of the DB instance that is the source of the automated backup.
boolean	equals(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) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
String	marker() The pagination token provided in the previous request.
Integer	maxRecords() The maximum number of records to include in the response.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeDbInstanceAutomatedBackupsRequest.Builder>	serializableBuilderClass()
DescribeDbInstanceAutomatedBackupsRequest.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

dbiResourceId

public String dbiResourceId()

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

Returns:

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

dbInstanceIdentifier

public String dbInstanceIdentifier()

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

Returns:

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

filters

public List<Filter> filters()

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

Supported filters are the following:

• status

  • active - automated backups for current instances

  • retained - automated backups for deleted instances

  • creating - automated backups that are waiting for the first automated snapshot to be available

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

• dbi-resource-id - Accepts DB instance resource identifiers and DB Amazon Resource Names (ARNs) for DB instances. The results list includes only information about the DB instance 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.

Returns:

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

Supported filters are the following:

• status

  • active - automated backups for current instances

  • retained - automated backups for deleted instances

  • creating - automated backups that are waiting for the first automated snapshot to be available

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

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

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

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.

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.

marker

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

Specified by:

toBuilder in class RdsRequest

Returns:

a builder for type T

builder

public static DescribeDbInstanceAutomatedBackupsRequest.Builder builder()

serializableBuilderClass

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