com.amazonaws.services.docdb.model

Class DescribeDBEngineVersionsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.docdb.model.DescribeDBEngineVersionsRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

Represents the input to DescribeDBEngineVersions.

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DescribeDBEngineVersionsRequest()

Method Summary

Modifier and Type	Method and Description
DescribeDBEngineVersionsRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getDBParameterGroupFamily() The name of a specific 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() This parameter is not currently supported.
Boolean	getListSupportedCharacterSets() If this parameter is specified and the requested engine supports the CharacterSetName parameter for CreateDBInstance, the response includes a list of supported character sets for each engine version.
Boolean	getListSupportedTimezones() If this parameter is specified and the requested engine supports the TimeZone parameter for CreateDBInstance, the response includes a list of supported time zones 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 the requested engine supports the CharacterSetName parameter for CreateDBInstance, the response includes a list of supported character sets for each engine version.
Boolean	isListSupportedTimezones() If this parameter is specified and the requested engine supports the TimeZone parameter for CreateDBInstance, the response includes a list of supported time zones for each engine version.
void	setDBParameterGroupFamily(String dBParameterGroupFamily) The name of a specific 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) This parameter is not currently supported.
void	setListSupportedCharacterSets(Boolean listSupportedCharacterSets) If this parameter is specified and the requested engine supports the CharacterSetName parameter for CreateDBInstance, the response includes a list of supported character sets for each engine version.
void	setListSupportedTimezones(Boolean listSupportedTimezones) If this parameter is specified and the requested engine supports the TimeZone parameter for CreateDBInstance, the response includes a list of supported time zones 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.
DescribeDBEngineVersionsRequest	withDBParameterGroupFamily(String dBParameterGroupFamily) The name of a specific 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) This parameter is not currently supported.
DescribeDBEngineVersionsRequest	withFilters(Filter... filters) This parameter is not currently supported.
DescribeDBEngineVersionsRequest	withListSupportedCharacterSets(Boolean listSupportedCharacterSets) If this parameter is specified and the requested engine supports the CharacterSetName parameter for CreateDBInstance, the response includes a list of supported character sets for each engine version.
DescribeDBEngineVersionsRequest	withListSupportedTimezones(Boolean listSupportedTimezones) If this parameter is specified and the requested engine supports the TimeZone parameter for CreateDBInstance, the response includes a list of supported time zones 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

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

DescribeDBEngineVersionsRequest

public DescribeDBEngineVersionsRequest()

Method Detail

setEngine

public void setEngine(String engine)

The database engine to return.

Parameters:

engine - The database engine to return.

getEngine

public String getEngine()

The database engine to return.

Returns:

The database engine to return.

withEngine

public DescribeDBEngineVersionsRequest withEngine(String engine)

The database engine to return.

Parameters:

engine - The database engine to return.

Returns:

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

setEngineVersion

public void setEngineVersion(String engineVersion)

The database engine version to return.

Example: 3.6.0

Parameters:

engineVersion - The database engine version to return.

Example: 3.6.0

getEngineVersion

public String getEngineVersion()

The database engine version to return.

Example: 3.6.0

Returns:

The database engine version to return.

Example: 3.6.0

withEngineVersion

public DescribeDBEngineVersionsRequest withEngineVersion(String engineVersion)

The database engine version to return.

Example: 3.6.0

Parameters:

engineVersion - The database engine version to return.

Example: 3.6.0

Returns:

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

setDBParameterGroupFamily

public void setDBParameterGroupFamily(String dBParameterGroupFamily)

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

Constraints:

• If provided, must match an existing DBParameterGroupFamily.

Parameters:

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

Constraints:

• If provided, must match an existing DBParameterGroupFamily.

getDBParameterGroupFamily

public String getDBParameterGroupFamily()

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

Constraints:

• If provided, must match an existing DBParameterGroupFamily.

Returns:

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

Constraints:

• If provided, must match an existing DBParameterGroupFamily.

withDBParameterGroupFamily

public DescribeDBEngineVersionsRequest withDBParameterGroupFamily(String dBParameterGroupFamily)

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

Constraints:

• If provided, must match an existing DBParameterGroupFamily.

Parameters:

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

Constraints:

• If provided, must match an existing DBParameterGroupFamily.

Returns:

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

getFilters

public List<Filter> getFilters()

This parameter is not currently supported.

Returns:

This parameter is not currently supported.

setFilters

public void setFilters(Collection<Filter> filters)

This parameter is not currently supported.

Parameters:

filters - This parameter is not currently supported.

withFilters

public DescribeDBEngineVersionsRequest withFilters(Filter... filters)

This parameter is 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.

Parameters:

filters - This parameter is not currently supported.

Returns:

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

withFilters

public DescribeDBEngineVersionsRequest withFilters(Collection<Filter> filters)

This parameter is not currently supported.

Parameters:

filters - This parameter is not 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 (marker) is included in the response so that the remaining 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 records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

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 (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 (marker) is included in the response so that the remaining 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 records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining 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 records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

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

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.

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.

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:

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

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.

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.

withDefaultOnly

public DescribeDBEngineVersionsRequest withDefaultOnly(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.

Returns:

Returns a reference to this 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.

setListSupportedCharacterSets

public void setListSupportedCharacterSets(Boolean listSupportedCharacterSets)

If this parameter is specified and 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 the requested engine supports the CharacterSetName parameter for CreateDBInstance, the response includes a list of supported character sets for each engine version.

getListSupportedCharacterSets

public Boolean getListSupportedCharacterSets()

If this parameter is specified and 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 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 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 the requested engine supports the CharacterSetName parameter for CreateDBInstance, the response includes a list of supported character sets for each engine version.

Returns:

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

isListSupportedCharacterSets

public Boolean isListSupportedCharacterSets()

If this parameter is specified and 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 the requested engine supports the CharacterSetName parameter for CreateDBInstance, the response includes a list of supported character sets for each engine version.

setListSupportedTimezones

public void setListSupportedTimezones(Boolean listSupportedTimezones)

If this parameter is specified and the requested engine supports the TimeZone parameter for CreateDBInstance, the response includes a list of supported time zones for each engine version.

Parameters:

listSupportedTimezones - If this parameter is specified and the requested engine supports the TimeZone parameter for CreateDBInstance, the response includes a list of supported time zones for each engine version.

getListSupportedTimezones

public Boolean getListSupportedTimezones()

If this parameter is specified and the requested engine supports the TimeZone parameter for CreateDBInstance, the response includes a list of supported time zones for each engine version.

Returns:

If this parameter is specified and the requested engine supports the TimeZone parameter for CreateDBInstance, the response includes a list of supported time zones for each engine version.

withListSupportedTimezones

public DescribeDBEngineVersionsRequest withListSupportedTimezones(Boolean listSupportedTimezones)

If this parameter is specified and the requested engine supports the TimeZone parameter for CreateDBInstance, the response includes a list of supported time zones for each engine version.

Parameters:

listSupportedTimezones - If this parameter is specified and the requested engine supports the TimeZone parameter for CreateDBInstance, the response includes a list of supported time zones for each engine version.

Returns:

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

isListSupportedTimezones

public Boolean isListSupportedTimezones()

If this parameter is specified and the requested engine supports the TimeZone parameter for CreateDBInstance, the response includes a list of supported time zones for each engine version.

Returns:

If this parameter is specified and the requested engine supports the TimeZone parameter for CreateDBInstance, the response includes a list of supported time zones for each engine version.

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 DescribeDBEngineVersionsRequest 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()