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	dbInstanceAutomatedBackupsArn() The Amazon Resource Name (ARN) of the replicated automated backups, for example, arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.
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)
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.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeDbInstanceAutomatedBackupsRequest.Builder>	serializableBuilderClass()
DescribeDbInstanceAutomatedBackupsRequest.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

dbiResourceId

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

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

  • active - automated backups for current instances

  • retained - automated backups for deleted instances and after backup replication is stopped

  • 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). The results list includes only information about the DB instance automated backups identified by these ARNs.

• dbi-resource-id - Accepts DB resource identifiers and Amazon Resource Names (ARNs). 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.

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

  • active - automated backups for current instances

  • retained - automated backups for deleted instances and after backup replication is stopped

  • 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). The results list includes only information about the DB instance automated backups identified by these ARNs.

• dbi-resource-id - Accepts DB resource identifiers and Amazon Resource Names (ARNs). 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 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.

dbInstanceAutomatedBackupsArn

public final String dbInstanceAutomatedBackupsArn()

The Amazon Resource Name (ARN) of the replicated automated backups, for example, arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.

This setting doesn't apply to RDS Custom.

Returns:

The Amazon Resource Name (ARN) of the replicated automated backups, for example, arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.

This setting doesn't apply to RDS Custom.

toBuilder

public DescribeDbInstanceAutomatedBackupsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeDbInstanceAutomatedBackupsRequest.Builder,DescribeDbInstanceAutomatedBackupsRequest>

Specified by:

toBuilder in class RdsRequest

builder

public static DescribeDbInstanceAutomatedBackupsRequest.Builder builder()

serializableBuilderClass

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