com.amazonaws.services.rds.model

Class DescribeOrderableDBInstanceOptionsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.rds.model.DescribeOrderableDBInstanceOptionsRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DescribeOrderableDBInstanceOptionsRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DescribeOrderableDBInstanceOptionsRequest()

Method Summary

Modifier and Type	Method and Description
DescribeOrderableDBInstanceOptionsRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getAvailabilityZoneGroup() The Availability Zone group associated with a Local Zone.
String	getDBInstanceClass() A filter to include only the available options for the specified DB instance class.
String	getEngine() The name of the database engine to describe DB instance options for.
String	getEngineVersion() A filter to include only the available options for the specified engine version.
List<Filter>	getFilters() This parameter isn't currently supported.
String	getLicenseModel() A filter to include only the available options for the specified license model.
String	getMarker() An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request.
Integer	getMaxRecords() The maximum number of records to include in the response.
Boolean	getVpc() Specifies whether to show only VPC or non-VPC offerings.
int	hashCode()
Boolean	isVpc() Specifies whether to show only VPC or non-VPC offerings.
void	setAvailabilityZoneGroup(String availabilityZoneGroup) The Availability Zone group associated with a Local Zone.
void	setDBInstanceClass(String dBInstanceClass) A filter to include only the available options for the specified DB instance class.
void	setEngine(String engine) The name of the database engine to describe DB instance options for.
void	setEngineVersion(String engineVersion) A filter to include only the available options for the specified engine version.
void	setFilters(Collection<Filter> filters) This parameter isn't currently supported.
void	setLicenseModel(String licenseModel) A filter to include only the available options for the specified license model.
void	setMarker(String marker) An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request.
void	setMaxRecords(Integer maxRecords) The maximum number of records to include in the response.
void	setVpc(Boolean vpc) Specifies whether to show only VPC or non-VPC offerings.
String	toString() Returns a string representation of this object.
DescribeOrderableDBInstanceOptionsRequest	withAvailabilityZoneGroup(String availabilityZoneGroup) The Availability Zone group associated with a Local Zone.
DescribeOrderableDBInstanceOptionsRequest	withDBInstanceClass(String dBInstanceClass) A filter to include only the available options for the specified DB instance class.
DescribeOrderableDBInstanceOptionsRequest	withEngine(String engine) The name of the database engine to describe DB instance options for.
DescribeOrderableDBInstanceOptionsRequest	withEngineVersion(String engineVersion) A filter to include only the available options for the specified engine version.
DescribeOrderableDBInstanceOptionsRequest	withFilters(Collection<Filter> filters) This parameter isn't currently supported.
DescribeOrderableDBInstanceOptionsRequest	withFilters(Filter... filters) This parameter isn't currently supported.
DescribeOrderableDBInstanceOptionsRequest	withLicenseModel(String licenseModel) A filter to include only the available options for the specified license model.
DescribeOrderableDBInstanceOptionsRequest	withMarker(String marker) An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request.
DescribeOrderableDBInstanceOptionsRequest	withMaxRecords(Integer maxRecords) The maximum number of records to include in the response.
DescribeOrderableDBInstanceOptionsRequest	withVpc(Boolean vpc) Specifies whether to show only VPC or non-VPC offerings.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DescribeOrderableDBInstanceOptionsRequest

public DescribeOrderableDBInstanceOptionsRequest()

Method Detail

setEngine

public void setEngine(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

Parameters:

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

getEngine

public String getEngine()

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

withEngine

public DescribeOrderableDBInstanceOptionsRequest withEngine(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

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setEngineVersion

public void setEngineVersion(String engineVersion)

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

Parameters:

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

getEngineVersion

public String getEngineVersion()

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.

withEngineVersion

public DescribeOrderableDBInstanceOptionsRequest withEngineVersion(String engineVersion)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setDBInstanceClass

public void setDBInstanceClass(String dBInstanceClass)

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

Parameters:

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

getDBInstanceClass

public String getDBInstanceClass()

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.

withDBInstanceClass

public DescribeOrderableDBInstanceOptionsRequest withDBInstanceClass(String dBInstanceClass)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setLicenseModel

public void setLicenseModel(String licenseModel)

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

RDS Custom supports only the BYOL licensing model.

Parameters:

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

RDS Custom supports only the BYOL licensing model.

getLicenseModel

public String getLicenseModel()

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.

withLicenseModel

public DescribeOrderableDBInstanceOptionsRequest withLicenseModel(String licenseModel)

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

RDS Custom supports only the BYOL licensing model.

Parameters:

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

RDS Custom supports only the BYOL licensing model.

Returns:

Returns a reference to this object so that method calls can be chained together.

setAvailabilityZoneGroup

public void setAvailabilityZoneGroup(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.

Parameters:

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.

getAvailabilityZoneGroup

public String getAvailabilityZoneGroup()

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.

withAvailabilityZoneGroup

public DescribeOrderableDBInstanceOptionsRequest withAvailabilityZoneGroup(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setVpc

public void setVpc(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.

Parameters:

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.

getVpc

public Boolean getVpc()

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.

withVpc

public DescribeOrderableDBInstanceOptionsRequest withVpc(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

isVpc

public Boolean isVpc()

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.

getFilters

public List<Filter> getFilters()

This parameter isn't currently supported.

Returns:

This parameter isn't currently supported.

setFilters

public void setFilters(Collection<Filter> filters)

This parameter isn't currently supported.

Parameters:

filters - This parameter isn't currently supported.

withFilters

public DescribeOrderableDBInstanceOptionsRequest withFilters(Filter... filters)

This parameter isn't currently supported.

NOTE: This method appends the values to the existing list (if any). Use setFilters(java.util.Collection) or withFilters(java.util.Collection) if you want to override the existing values.

Parameters:

filters - This parameter isn't currently supported.

Returns:

Returns a reference to this object so that method calls can be chained together.

withFilters

public DescribeOrderableDBInstanceOptionsRequest withFilters(Collection<Filter> filters)

This parameter isn't currently supported.

Parameters:

filters - This parameter isn't currently supported.

Returns:

Returns a reference to this object so that method calls can be chained together.

setMaxRecords

public void setMaxRecords(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.

Parameters:

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.

getMaxRecords

public Integer getMaxRecords()

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.

withMaxRecords

public DescribeOrderableDBInstanceOptionsRequest withMaxRecords(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setMarker

public void setMarker(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.

Parameters:

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.

getMarker

public String getMarker()

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.

withMarker

public DescribeOrderableDBInstanceOptionsRequest withMarker(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public DescribeOrderableDBInstanceOptionsRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()