@Generated(value="software.amazon.awssdk:codegen") public class DescribeDBInstancesRequest extends RDSRequest implements ToCopyableBuilder<DescribeDBInstancesRequest.Builder,DescribeDBInstancesRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
DescribeDBInstancesRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static DescribeDBInstancesRequest.Builder |
builder() |
String |
dbInstanceIdentifier()
The user-supplied instance identifier.
|
boolean |
equals(Object obj) |
List<Filter> |
filters()
A filter that specifies one or more DB instances 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
DescribeDBInstances request. |
Integer |
maxRecords()
The maximum number of records to include in the response.
|
static Class<? extends DescribeDBInstancesRequest.Builder> |
serializableBuilderClass() |
DescribeDBInstancesRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
requestOverrideConfig
copy
public String dbInstanceIdentifier()
The user-supplied instance identifier. If this parameter is specified, information from only the specific DB instance is returned. This parameter isn't case-sensitive.
Constraints:
If supplied, must match the identifier of an existing DBInstance.
Constraints:
If supplied, must match the identifier of an existing DBInstance.
public List<Filter> filters()
A filter that specifies one or more DB instances to describe.
Supported filters:
db-cluster-id
- Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The
results list will only include information about the DB instances associated with the DB clusters identified by
these ARNs.
db-instance-id
- Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs). The
results list will only include information about the DB instances identified by these ARNs.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
Supported filters:
db-cluster-id
- Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs).
The results list will only include information about the DB instances associated with the DB clusters
identified by these ARNs.
db-instance-id
- Accepts DB instance identifiers and DB instance Amazon Resource Names
(ARNs). The results list will only include information about the DB instances identified by these ARNs.
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.
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.
public String marker()
An optional pagination token provided by a previous DescribeDBInstances
request. If this parameter
is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.
DescribeDBInstances
request. If this
parameter is specified, the response includes only records beyond the marker, up to the value specified
by MaxRecords
.public DescribeDBInstancesRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<DescribeDBInstancesRequest.Builder,DescribeDBInstancesRequest>
toBuilder
in class RDSRequest
public static DescribeDBInstancesRequest.Builder builder()
public static Class<? extends DescribeDBInstancesRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
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.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.