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

Class DescribeReservedDbInstancesRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeReservedDbInstancesRequest.Builder,DescribeReservedDbInstancesRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeReservedDbInstancesRequest.Builder

Method Summary

Modifier and Type	Method	Description
static DescribeReservedDbInstancesRequest.Builder	builder()
String	dbInstanceClass()	The DB instance class filter value.
String	duration()	The duration filter value, specified in years or seconds.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<Filter>	filters()	This parameter isn't currently supported.
<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	leaseId()	The lease identifier filter value.
String	marker()	An optional pagination token provided by a previous request.
Integer	maxRecords()	The maximum number of records to include in the response.
Boolean	multiAZ()	Specifies whether to show only those reservations that support Multi-AZ.
String	offeringType()	The offering type filter value.
String	productDescription()	The product description filter value.
String	reservedDBInstanceId()	The reserved DB instance identifier filter value.
String	reservedDBInstancesOfferingId()	The offering identifier filter value.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeReservedDbInstancesRequest.Builder>	serializableBuilderClass()
DescribeReservedDbInstancesRequest.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

reservedDBInstanceId

public final String reservedDBInstanceId()

The reserved DB instance identifier filter value. Specify this parameter to show only the reservation that matches the specified reservation ID.

Returns:

The reserved DB instance identifier filter value. Specify this parameter to show only the reservation that matches the specified reservation ID.

reservedDBInstancesOfferingId

public final String reservedDBInstancesOfferingId()

The offering identifier filter value. Specify this parameter to show only purchased reservations matching the specified offering identifier.

Returns:

The offering identifier filter value. Specify this parameter to show only purchased reservations matching the specified offering identifier.

dbInstanceClass

public final String dbInstanceClass()

The DB instance class filter value. Specify this parameter to show only those reservations matching the specified DB instances class.

Returns:

The DB instance class filter value. Specify this parameter to show only those reservations matching the specified DB instances class.

duration

public final String duration()

The duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.

Valid Values: 1 | 3 | 31536000 | 94608000

Returns:

The duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.

Valid Values: 1 | 3 | 31536000 | 94608000

productDescription

public final String productDescription()

The product description filter value. Specify this parameter to show only those reservations matching the specified product description.

Returns:

The product description filter value. Specify this parameter to show only those reservations matching the specified product description.

offeringType

public final String offeringType()

The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.

Valid Values: "Partial Upfront" | "All Upfront" | "No Upfront"

Returns:

The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.

Valid Values: "Partial Upfront" | "All Upfront" | "No Upfront"

multiAZ

public final Boolean multiAZ()

Specifies whether to show only those reservations that support Multi-AZ.

Returns:

Specifies whether to show only those reservations that support Multi-AZ.

leaseId

public final String leaseId()

The lease identifier filter value. Specify this parameter to show only the reservation that matches the specified lease ID.

Amazon Web Services Support might request the lease ID for an issue related to a reserved DB instance.

Returns:

The lease identifier filter value. Specify this parameter to show only the reservation that matches the specified lease ID.

Amazon Web Services Support might request the lease ID for an issue related to a reserved 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()

This parameter isn't currently supported.

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:

This parameter isn't currently supported.

maxRecords

public final Integer maxRecords()

The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so 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 than the MaxRecords value is available, a pagination token called a marker is included in the response so 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 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 request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

toBuilder

public DescribeReservedDbInstancesRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeReservedDbInstancesRequest.Builder,DescribeReservedDbInstancesRequest>

Specified by:

toBuilder in class RdsRequest

builder

public static DescribeReservedDbInstancesRequest.Builder builder()

serializableBuilderClass

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