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

Class DescribeOrderableDbInstanceOptionsRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeOrderableDbInstanceOptionsRequest.Builder,DescribeOrderableDbInstanceOptionsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeOrderableDbInstanceOptionsRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	availabilityZoneGroup()	The Availability Zone group associated with a Local Zone.
static DescribeOrderableDbInstanceOptionsRequest.Builder	builder()
String	dbInstanceClass()	A filter to include only the available options for the specified DB instance class.
String	engine()	The name of the database engine to describe DB instance options for.
String	engineVersion()	A filter to include only the available options for the specified engine version.
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	licenseModel()	A filter to include only the available options for the specified license model.
String	marker()	An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request.
Integer	maxRecords()	The maximum number of records to include in the response.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeOrderableDbInstanceOptionsRequest.Builder>	serializableBuilderClass()
DescribeOrderableDbInstanceOptionsRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
Boolean	vpc()	Specifies whether to show only VPC or non-VPC offerings.

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

engine

public final String engine()

The name of the database engine to describe DB instance options for.

Valid Values:

• aurora-mysql

• aurora-postgresql

• custom-oracle-ee

• custom-oracle-ee-cdb

• custom-oracle-se2

• custom-oracle-se2-cdb

• db2-ae

• db2-se

• mariadb

• mysql

• oracle-ee

• oracle-ee-cdb

• oracle-se2

• oracle-se2-cdb

• postgres

• sqlserver-ee

• sqlserver-se

• sqlserver-ex

• sqlserver-web

Returns:

The name of the database engine to describe DB instance options for.

Valid Values:

• aurora-mysql

• aurora-postgresql

• custom-oracle-ee

• custom-oracle-ee-cdb

• custom-oracle-se2

• custom-oracle-se2-cdb

• db2-ae

• db2-se

• mariadb

• mysql

• oracle-ee

• oracle-ee-cdb

• oracle-se2

• oracle-se2-cdb

• postgres

• sqlserver-ee

• sqlserver-se

• sqlserver-ex

• sqlserver-web

engineVersion

public final String engineVersion()

A filter to include only the available options for the specified engine version.

Returns:

A filter to include only the available options for the specified engine version.

dbInstanceClass

public final String dbInstanceClass()

A filter to include only the available options for the specified DB instance class.

Returns:

A filter to include only the available options for the specified DB instance class.

licenseModel

public final String licenseModel()

A filter to include only the available options for the specified license model.

RDS Custom supports only the BYOL licensing model.

Returns:

A filter to include only the available options for the specified license model.

RDS Custom supports only the BYOL licensing model.

availabilityZoneGroup

public final String availabilityZoneGroup()

The Availability Zone group associated with a Local Zone. Specify this parameter to retrieve available options for the Local Zones in the group.

Omit this parameter to show the available options in the specified Amazon Web Services Region.

This setting doesn't apply to RDS Custom DB instances.

Returns:

The Availability Zone group associated with a Local Zone. Specify this parameter to retrieve available options for the Local Zones in the group.

Omit this parameter to show the available options in the specified Amazon Web Services Region.

This setting doesn't apply to RDS Custom DB instances.

vpc

public final Boolean vpc()

Specifies whether to show only VPC or non-VPC offerings. RDS Custom supports only VPC offerings.

RDS Custom supports only VPC offerings. If you describe non-VPC offerings for RDS Custom, the output shows VPC offerings.

Returns:

Specifies whether to show only VPC or non-VPC offerings. RDS Custom supports only VPC offerings.

RDS Custom supports only VPC offerings. If you describe non-VPC offerings for RDS Custom, the output shows VPC offerings.

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

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

marker

public final String marker()

An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions 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 DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

toBuilder

public DescribeOrderableDbInstanceOptionsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeOrderableDbInstanceOptionsRequest.Builder,DescribeOrderableDbInstanceOptionsRequest>

Specified by:

toBuilder in class RdsRequest

builder

public static DescribeOrderableDbInstanceOptionsRequest.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo