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

Class DescribeDbInstancesRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeDbInstancesRequest.Builder,DescribeDbInstancesRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeDbInstancesRequest.Builder

Method Summary

Modifier and Type	Method	Description
static DescribeDbInstancesRequest.Builder	builder()
String	dbInstanceIdentifier()	The user-supplied instance identifier or the Amazon Resource Name (ARN) of the DB instance.
boolean	equals(Object obj)
boolean	equalsBySdkFields(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)
boolean	hasFilters()	For responses, this returns true if the service returned a value for the Filters property.
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.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeDbInstancesRequest.Builder>	serializableBuilderClass()
DescribeDbInstancesRequest.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

dbInstanceIdentifier

public final String dbInstanceIdentifier()

The user-supplied instance identifier or the Amazon Resource Name (ARN) of the DB instance. 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 DB instance.

Returns:

The user-supplied instance identifier or the Amazon Resource Name (ARN) of the DB instance. 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 DB instance.

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 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 only includes 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 only includes information about the DB instances identified by these ARNs.

• dbi-resource-id - Accepts DB instance resource identifiers. The results list only includes information about the DB instances identified by these DB instance resource identifiers.

• domain - Accepts Active Directory directory IDs. The results list only includes information about the DB instances associated with these domains.

• engine - Accepts engine names. The results list only includes information about the DB instances for these engines.

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 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 only includes 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 only includes information about the DB instances identified by these ARNs.

• dbi-resource-id - Accepts DB instance resource identifiers. The results list only includes information about the DB instances identified by these DB instance resource identifiers.

• domain - Accepts Active Directory directory IDs. The results list only includes information about the DB instances associated with these domains.

• engine - Accepts engine names. The results list only includes information about the DB instances for these engines.

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.

Default: 100

Constraints: Minimum 20, maximum 100.

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.

Default: 100

Constraints: Minimum 20, maximum 100.

marker

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

Returns:

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.

toBuilder

public DescribeDbInstancesRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeDbInstancesRequest.Builder,DescribeDbInstancesRequest>

Specified by:

toBuilder in class RdsRequest

builder

public static DescribeDbInstancesRequest.Builder builder()

serializableBuilderClass

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