Class DescribeDbInstanceAutomatedBackupsRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<DescribeDbInstanceAutomatedBackupsRequest.Builder,
DescribeDbInstanceAutomatedBackupsRequest>
Parameter input for DescribeDBInstanceAutomatedBackups.
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic interface
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
The Amazon Resource Name (ARN) of the replicated automated backups, for example,arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE
.final String
(Optional) The user-supplied instance identifier.final String
The resource ID of the DB instance that is the source of the automated backup.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.filters()
A filter that specifies which resources to return based on status.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final boolean
For responses, this returns true if the service returned a value for the Filters property.final int
hashCode()
final String
marker()
The pagination token provided in the previous request.final Integer
The maximum number of records to include in the response.static Class
<? extends DescribeDbInstanceAutomatedBackupsRequest.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
(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's 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'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 theisEmpty()
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
A filter that specifies which resources to return based on status.
Supported filters are the following:
-
status
-
active
- Automated backups for current instances. -
creating
- Automated backups that are waiting for the first automated snapshot to be available. -
retained
- Automated backups for deleted instances and after backup replication is stopped.
-
-
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. -
creating
- Automated backups that are waiting for the first automated snapshot to be available. -
retained
- Automated backups for deleted instances and after backup replication is stopped.
-
-
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
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
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
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
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 interfaceToCopyableBuilder<DescribeDbInstanceAutomatedBackupsRequest.Builder,
DescribeDbInstanceAutomatedBackupsRequest> - Specified by:
toBuilder
in classRdsRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
public static Class<? extends DescribeDbInstanceAutomatedBackupsRequest.Builder> serializableBuilderClass() -
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- 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
-