software.amazon.awssdk.services.neptune.model

Class DescribeDbInstancesRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.neptune.model.NeptuneRequest

software.amazon.awssdk.services.neptune.model.DescribeDbInstancesRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeDbInstancesRequest.Builder,DescribeDbInstancesRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeDbInstancesRequest.Builder

Method Summary

Modifier and Type	Method and Description
static DescribeDbInstancesRequest.Builder	builder()
String	dbInstanceIdentifier() The user-supplied instance identifier.
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() Returns true if the Filters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
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. 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.

Returns:

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.

hasFilters

public final boolean hasFilters()

Returns true if the Filters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

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 will only include information about the DB instances associated with the DB clusters identified by these ARNs.

• engine - Accepts an engine name (such as neptune), and restricts the results list to DB instances created by that engine.

For example, to invoke this API from the Amazon CLI and filter so that only Neptune DB instances are returned, you could use the following command:

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasFilters() to see if a value was sent in this field.

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 will only include information about the DB instances associated with the DB clusters identified by these ARNs.

• engine - Accepts an engine name (such as neptune), and restricts the results list to DB instances created by that engine.

For example, to invoke this API from the Amazon CLI and filter so that only Neptune DB instances are returned, you could use the following command:

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 the remaining results can be retrieved.

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 the remaining results can be retrieved.

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 NeptuneRequest

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