com.amazonaws.services.rds.model

Class DescribeDBEngineVersionsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.rds.model.DescribeDBEngineVersionsRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class DescribeDBEngineVersionsRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the DescribeDBEngineVersions operation.

Returns a list of the available DB engines.

See Also:

AmazonRDS.describeDBEngineVersions(DescribeDBEngineVersionsRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DescribeDBEngineVersionsRequest() Default constructor for a new DescribeDBEngineVersionsRequest object.

Method Summary

Methods

Modifier and Type	Method and Description
DescribeDBEngineVersionsRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
String	getDBParameterGroupFamily() The name of a specific DB parameter group family to return details for.
Boolean	getDefaultOnly() Indicates that only the default version of the specified engine or engine and major version combination is returned.
String	getEngine() The database engine to return.
String	getEngineVersion() The database engine version to return.
List<Filter>	getFilters() Not currently supported.
Boolean	getListSupportedCharacterSets() If this parameter is specified, and if the requested engine supports the CharacterSetName parameter for CreateDBInstance, the response includes a list of supported character sets for each engine version.
String	getMarker() An optional pagination token provided by a previous request.
Integer	getMaxRecords() The maximum number of records to include in the response.
int	hashCode()
Boolean	isDefaultOnly() Indicates that only the default version of the specified engine or engine and major version combination is returned.
Boolean	isListSupportedCharacterSets() If this parameter is specified, and if the requested engine supports the CharacterSetName parameter for CreateDBInstance, the response includes a list of supported character sets for each engine version.
void	setDBParameterGroupFamily(String dBParameterGroupFamily) The name of a specific DB parameter group family to return details for.
void	setDefaultOnly(Boolean defaultOnly) Indicates that only the default version of the specified engine or engine and major version combination is returned.
void	setEngine(String engine) The database engine to return.
void	setEngineVersion(String engineVersion) The database engine version to return.
void	setFilters(Collection<Filter> filters) Not currently supported.
void	setListSupportedCharacterSets(Boolean listSupportedCharacterSets) If this parameter is specified, and if the requested engine supports the CharacterSetName parameter for CreateDBInstance, the response includes a list of supported character sets for each engine version.
void	setMarker(String marker) An optional pagination token provided by a previous request.
void	setMaxRecords(Integer maxRecords) The maximum number of records to include in the response.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DescribeDBEngineVersionsRequest	withDBParameterGroupFamily(String dBParameterGroupFamily) The name of a specific DB parameter group family to return details for.
DescribeDBEngineVersionsRequest	withDefaultOnly(Boolean defaultOnly) Indicates that only the default version of the specified engine or engine and major version combination is returned.
DescribeDBEngineVersionsRequest	withEngine(String engine) The database engine to return.
DescribeDBEngineVersionsRequest	withEngineVersion(String engineVersion) The database engine version to return.
DescribeDBEngineVersionsRequest	withFilters(Collection<Filter> filters) Not currently supported.
DescribeDBEngineVersionsRequest	withFilters(Filter... filters) Not currently supported.
DescribeDBEngineVersionsRequest	withListSupportedCharacterSets(Boolean listSupportedCharacterSets) If this parameter is specified, and if the requested engine supports the CharacterSetName parameter for CreateDBInstance, the response includes a list of supported character sets for each engine version.
DescribeDBEngineVersionsRequest	withMarker(String marker) An optional pagination token provided by a previous request.
DescribeDBEngineVersionsRequest	withMaxRecords(Integer maxRecords) The maximum number of records to include in the response.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DescribeDBEngineVersionsRequest

public DescribeDBEngineVersionsRequest()

Default constructor for a new DescribeDBEngineVersionsRequest object. Callers should use the setter or fluent setter (with...) methods to initialize this object after creating it.

Method Detail

getEngine

public String getEngine()

The database engine to return.

Returns:

The database engine to return.

setEngine

public void setEngine(String engine)

The database engine to return.

Parameters:

engine - The database engine to return.

withEngine

public DescribeDBEngineVersionsRequest withEngine(String engine)

The database engine to return.

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

Parameters:

engine - The database engine to return.

Returns:

A reference to this updated object so that method calls can be chained together.

getEngineVersion

public String getEngineVersion()

The database engine version to return.

Example: 5.1.49

Returns:

The database engine version to return.

Example: 5.1.49

setEngineVersion

public void setEngineVersion(String engineVersion)

The database engine version to return.

Example: 5.1.49

Parameters:

engineVersion - The database engine version to return.

Example: 5.1.49

withEngineVersion

public DescribeDBEngineVersionsRequest withEngineVersion(String engineVersion)

The database engine version to return.

Example: 5.1.49

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

Parameters:

engineVersion - The database engine version to return.

Example: 5.1.49

Returns:

A reference to this updated object so that method calls can be chained together.

getDBParameterGroupFamily

public String getDBParameterGroupFamily()

The name of a specific DB parameter group family to return details for.

Constraints:

• Must be 1 to 255 alphanumeric characters
• First character must be a letter
• Cannot end with a hyphen or contain two consecutive hyphens

Returns:

The name of a specific DB parameter group family to return details for.

Constraints:

• Must be 1 to 255 alphanumeric characters
• First character must be a letter
• Cannot end with a hyphen or contain two consecutive hyphens

setDBParameterGroupFamily

public void setDBParameterGroupFamily(String dBParameterGroupFamily)

The name of a specific DB parameter group family to return details for.

Constraints:

• Must be 1 to 255 alphanumeric characters
• First character must be a letter
• Cannot end with a hyphen or contain two consecutive hyphens

Parameters:

dBParameterGroupFamily - The name of a specific DB parameter group family to return details for.

Constraints:

• Must be 1 to 255 alphanumeric characters
• First character must be a letter
• Cannot end with a hyphen or contain two consecutive hyphens

withDBParameterGroupFamily

public DescribeDBEngineVersionsRequest withDBParameterGroupFamily(String dBParameterGroupFamily)

The name of a specific DB parameter group family to return details for.

Constraints:

• Must be 1 to 255 alphanumeric characters
• First character must be a letter
• Cannot end with a hyphen or contain two consecutive hyphens

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

Parameters:

dBParameterGroupFamily - The name of a specific DB parameter group family to return details for.

Constraints:

• Must be 1 to 255 alphanumeric characters
• First character must be a letter
• Cannot end with a hyphen or contain two consecutive hyphens

Returns:

A reference to this updated object so that method calls can be chained together.

getFilters

public List<Filter> getFilters()

Not currently supported.

Returns:

Not currently supported.

setFilters

public void setFilters(Collection<Filter> filters)

Not currently supported.

Parameters:

filters - Not currently supported.

withFilters

public DescribeDBEngineVersionsRequest withFilters(Filter... filters)

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

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

Parameters:

filters - Not currently supported.

Returns:

A reference to this updated object so that method calls can be chained together.

withFilters

public DescribeDBEngineVersionsRequest withFilters(Collection<Filter> filters)

Not currently supported.

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

Parameters:

filters - Not currently supported.

Returns:

A reference to this updated object so that method calls can be chained together.

getMaxRecords

public Integer getMaxRecords()

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

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

Default: 100

Constraints: Minimum 20, maximum 100.

setMaxRecords

public void setMaxRecords(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 that the following results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

Parameters:

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

Default: 100

Constraints: Minimum 20, maximum 100.

withMaxRecords

public DescribeDBEngineVersionsRequest withMaxRecords(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 that the following results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

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

Parameters:

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

Default: 100

Constraints: Minimum 20, maximum 100.

Returns:

A reference to this updated object so that method calls can be chained together.

getMarker

public String getMarker()

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.

setMarker

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

Parameters:

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.

withMarker

public DescribeDBEngineVersionsRequest withMarker(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 a reference to this object so that method calls can be chained together.

Parameters:

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:

A reference to this updated object so that method calls can be chained together.

isDefaultOnly

public Boolean isDefaultOnly()

Indicates that only the default version of the specified engine or engine and major version combination is returned.

Returns:

Indicates that only the default version of the specified engine or engine and major version combination is returned.

setDefaultOnly

public void setDefaultOnly(Boolean defaultOnly)

Indicates that only the default version of the specified engine or engine and major version combination is returned.

Parameters:

defaultOnly - Indicates that only the default version of the specified engine or engine and major version combination is returned.

withDefaultOnly

public DescribeDBEngineVersionsRequest withDefaultOnly(Boolean defaultOnly)

Indicates that only the default version of the specified engine or engine and major version combination is returned.

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

Parameters:

defaultOnly - Indicates that only the default version of the specified engine or engine and major version combination is returned.

Returns:

A reference to this updated object so that method calls can be chained together.

getDefaultOnly

public Boolean getDefaultOnly()

Indicates that only the default version of the specified engine or engine and major version combination is returned.

Returns:

Indicates that only the default version of the specified engine or engine and major version combination is returned.

isListSupportedCharacterSets

public Boolean isListSupportedCharacterSets()

If this parameter is specified, and if the requested engine supports the CharacterSetName parameter for CreateDBInstance, the response includes a list of supported character sets for each engine version.

Returns:

If this parameter is specified, and if the requested engine supports the CharacterSetName parameter for CreateDBInstance, the response includes a list of supported character sets for each engine version.

setListSupportedCharacterSets

public void setListSupportedCharacterSets(Boolean listSupportedCharacterSets)

If this parameter is specified, and if the requested engine supports the CharacterSetName parameter for CreateDBInstance, the response includes a list of supported character sets for each engine version.

Parameters:

listSupportedCharacterSets - If this parameter is specified, and if the requested engine supports the CharacterSetName parameter for CreateDBInstance, the response includes a list of supported character sets for each engine version.

withListSupportedCharacterSets

public DescribeDBEngineVersionsRequest withListSupportedCharacterSets(Boolean listSupportedCharacterSets)

If this parameter is specified, and if the requested engine supports the CharacterSetName parameter for CreateDBInstance, the response includes a list of supported character sets for each engine version.

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

Parameters:

listSupportedCharacterSets - If this parameter is specified, and if the requested engine supports the CharacterSetName parameter for CreateDBInstance, the response includes a list of supported character sets for each engine version.

Returns:

A reference to this updated object so that method calls can be chained together.

getListSupportedCharacterSets

public Boolean getListSupportedCharacterSets()

If this parameter is specified, and if the requested engine supports the CharacterSetName parameter for CreateDBInstance, the response includes a list of supported character sets for each engine version.

Returns:

If this parameter is specified, and if the requested engine supports the CharacterSetName parameter for CreateDBInstance, the response includes a list of supported character sets for each engine version.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public DescribeDBEngineVersionsRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()