@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class DescribeDBEngineVersionsRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
DescribeDBEngineVersionsRequest() |
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 DB parameter group family to return details for.
|
Boolean |
getDefaultOnly()
Specifies whether to return only the default version of the specified engine or the engine and major version
combination.
|
String |
getEngine()
The database engine to return version details for.
|
String |
getEngineVersion()
A specific database engine version to return details for.
|
List<Filter> |
getFilters()
A filter that specifies one or more DB engine versions to describe.
|
Boolean |
getIncludeAll()
Specifies whether to also list the engine versions that aren't available.
|
Boolean |
getListSupportedCharacterSets()
Specifies whether to list the supported character sets for each engine version.
|
Boolean |
getListSupportedTimezones()
Specifies whether to list the 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()
Specifies whether to return only the default version of the specified engine or the engine and major version
combination.
|
Boolean |
isIncludeAll()
Specifies whether to also list the engine versions that aren't available.
|
Boolean |
isListSupportedCharacterSets()
Specifies whether to list the supported character sets for each engine version.
|
Boolean |
isListSupportedTimezones()
Specifies whether to list the supported time zones 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)
Specifies whether to return only the default version of the specified engine or the engine and major version
combination.
|
void |
setEngine(String engine)
The database engine to return version details for.
|
void |
setEngineVersion(String engineVersion)
A specific database engine version to return details for.
|
void |
setFilters(Collection<Filter> filters)
A filter that specifies one or more DB engine versions to describe.
|
void |
setIncludeAll(Boolean includeAll)
Specifies whether to also list the engine versions that aren't available.
|
void |
setListSupportedCharacterSets(Boolean listSupportedCharacterSets)
Specifies whether to list the supported character sets for each engine version.
|
void |
setListSupportedTimezones(Boolean listSupportedTimezones)
Specifies whether to list the 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 DB parameter group family to return details for.
|
DescribeDBEngineVersionsRequest |
withDefaultOnly(Boolean defaultOnly)
Specifies whether to return only the default version of the specified engine or the engine and major version
combination.
|
DescribeDBEngineVersionsRequest |
withEngine(String engine)
The database engine to return version details for.
|
DescribeDBEngineVersionsRequest |
withEngineVersion(String engineVersion)
A specific database engine version to return details for.
|
DescribeDBEngineVersionsRequest |
withFilters(Collection<Filter> filters)
A filter that specifies one or more DB engine versions to describe.
|
DescribeDBEngineVersionsRequest |
withFilters(Filter... filters)
A filter that specifies one or more DB engine versions to describe.
|
DescribeDBEngineVersionsRequest |
withIncludeAll(Boolean includeAll)
Specifies whether to also list the engine versions that aren't available.
|
DescribeDBEngineVersionsRequest |
withListSupportedCharacterSets(Boolean listSupportedCharacterSets)
Specifies whether to list the supported character sets for each engine version.
|
DescribeDBEngineVersionsRequest |
withListSupportedTimezones(Boolean listSupportedTimezones)
Specifies whether to list the 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.
|
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
public void setEngine(String engine)
The database engine to return version details 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
engine
- The database engine to return version details 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
public String getEngine()
The database engine to return version details 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
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
public DescribeDBEngineVersionsRequest withEngine(String engine)
The database engine to return version details 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
engine
- The database engine to return version details 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
public void setEngineVersion(String engineVersion)
A specific database engine version to return details for.
Example: 5.1.49
engineVersion
- A specific database engine version to return details for.
Example: 5.1.49
public String getEngineVersion()
A specific database engine version to return details for.
Example: 5.1.49
Example: 5.1.49
public DescribeDBEngineVersionsRequest withEngineVersion(String engineVersion)
A specific database engine version to return details for.
Example: 5.1.49
engineVersion
- A specific database engine version to return details for.
Example: 5.1.49
public void setDBParameterGroupFamily(String dBParameterGroupFamily)
The name of a specific DB parameter group family to return details for.
Constraints:
If supplied, must match an existing DB parameter group family.
dBParameterGroupFamily
- The name of a specific DB parameter group family to return details for.
Constraints:
If supplied, must match an existing DB parameter group family.
public String getDBParameterGroupFamily()
The name of a specific DB parameter group family to return details for.
Constraints:
If supplied, must match an existing DB parameter group family.
Constraints:
If supplied, must match an existing DB parameter group family.
public DescribeDBEngineVersionsRequest withDBParameterGroupFamily(String dBParameterGroupFamily)
The name of a specific DB parameter group family to return details for.
Constraints:
If supplied, must match an existing DB parameter group family.
dBParameterGroupFamily
- The name of a specific DB parameter group family to return details for.
Constraints:
If supplied, must match an existing DB parameter group family.
public List<Filter> getFilters()
A filter that specifies one or more DB engine versions to describe.
Supported filters:
db-parameter-group-family
- Accepts parameter groups family names. The results list only includes
information about the DB engine versions for these parameter group families.
engine
- Accepts engine names. The results list only includes information about the DB engine
versions for these engines.
engine-mode
- Accepts DB engine modes. The results list only includes information about the DB
engine versions for these engine modes. Valid DB engine modes are the following:
global
multimaster
parallelquery
provisioned
serverless
engine-version
- Accepts engine versions. The results list only includes information about the DB
engine versions for these engine versions.
status
- Accepts engine version statuses. The results list only includes information about the DB
engine versions for these statuses. Valid statuses are the following:
available
deprecated
Supported filters:
db-parameter-group-family
- Accepts parameter groups family names. The results list only
includes information about the DB engine versions for these parameter group families.
engine
- Accepts engine names. The results list only includes information about the DB
engine versions for these engines.
engine-mode
- Accepts DB engine modes. The results list only includes information about the
DB engine versions for these engine modes. Valid DB engine modes are the following:
global
multimaster
parallelquery
provisioned
serverless
engine-version
- Accepts engine versions. The results list only includes information about
the DB engine versions for these engine versions.
status
- Accepts engine version statuses. The results list only includes information about
the DB engine versions for these statuses. Valid statuses are the following:
available
deprecated
public void setFilters(Collection<Filter> filters)
A filter that specifies one or more DB engine versions to describe.
Supported filters:
db-parameter-group-family
- Accepts parameter groups family names. The results list only includes
information about the DB engine versions for these parameter group families.
engine
- Accepts engine names. The results list only includes information about the DB engine
versions for these engines.
engine-mode
- Accepts DB engine modes. The results list only includes information about the DB
engine versions for these engine modes. Valid DB engine modes are the following:
global
multimaster
parallelquery
provisioned
serverless
engine-version
- Accepts engine versions. The results list only includes information about the DB
engine versions for these engine versions.
status
- Accepts engine version statuses. The results list only includes information about the DB
engine versions for these statuses. Valid statuses are the following:
available
deprecated
filters
- A filter that specifies one or more DB engine versions to describe.
Supported filters:
db-parameter-group-family
- Accepts parameter groups family names. The results list only
includes information about the DB engine versions for these parameter group families.
engine
- Accepts engine names. The results list only includes information about the DB engine
versions for these engines.
engine-mode
- Accepts DB engine modes. The results list only includes information about the
DB engine versions for these engine modes. Valid DB engine modes are the following:
global
multimaster
parallelquery
provisioned
serverless
engine-version
- Accepts engine versions. The results list only includes information about
the DB engine versions for these engine versions.
status
- Accepts engine version statuses. The results list only includes information about
the DB engine versions for these statuses. Valid statuses are the following:
available
deprecated
public DescribeDBEngineVersionsRequest withFilters(Filter... filters)
A filter that specifies one or more DB engine versions to describe.
Supported filters:
db-parameter-group-family
- Accepts parameter groups family names. The results list only includes
information about the DB engine versions for these parameter group families.
engine
- Accepts engine names. The results list only includes information about the DB engine
versions for these engines.
engine-mode
- Accepts DB engine modes. The results list only includes information about the DB
engine versions for these engine modes. Valid DB engine modes are the following:
global
multimaster
parallelquery
provisioned
serverless
engine-version
- Accepts engine versions. The results list only includes information about the DB
engine versions for these engine versions.
status
- Accepts engine version statuses. The results list only includes information about the DB
engine versions for these statuses. Valid statuses are the following:
available
deprecated
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.
filters
- A filter that specifies one or more DB engine versions to describe.
Supported filters:
db-parameter-group-family
- Accepts parameter groups family names. The results list only
includes information about the DB engine versions for these parameter group families.
engine
- Accepts engine names. The results list only includes information about the DB engine
versions for these engines.
engine-mode
- Accepts DB engine modes. The results list only includes information about the
DB engine versions for these engine modes. Valid DB engine modes are the following:
global
multimaster
parallelquery
provisioned
serverless
engine-version
- Accepts engine versions. The results list only includes information about
the DB engine versions for these engine versions.
status
- Accepts engine version statuses. The results list only includes information about
the DB engine versions for these statuses. Valid statuses are the following:
available
deprecated
public DescribeDBEngineVersionsRequest withFilters(Collection<Filter> filters)
A filter that specifies one or more DB engine versions to describe.
Supported filters:
db-parameter-group-family
- Accepts parameter groups family names. The results list only includes
information about the DB engine versions for these parameter group families.
engine
- Accepts engine names. The results list only includes information about the DB engine
versions for these engines.
engine-mode
- Accepts DB engine modes. The results list only includes information about the DB
engine versions for these engine modes. Valid DB engine modes are the following:
global
multimaster
parallelquery
provisioned
serverless
engine-version
- Accepts engine versions. The results list only includes information about the DB
engine versions for these engine versions.
status
- Accepts engine version statuses. The results list only includes information about the DB
engine versions for these statuses. Valid statuses are the following:
available
deprecated
filters
- A filter that specifies one or more DB engine versions to describe.
Supported filters:
db-parameter-group-family
- Accepts parameter groups family names. The results list only
includes information about the DB engine versions for these parameter group families.
engine
- Accepts engine names. The results list only includes information about the DB engine
versions for these engines.
engine-mode
- Accepts DB engine modes. The results list only includes information about the
DB engine versions for these engine modes. Valid DB engine modes are the following:
global
multimaster
parallelquery
provisioned
serverless
engine-version
- Accepts engine versions. The results list only includes information about
the DB engine versions for these engine versions.
status
- Accepts engine version statuses. The results list only includes information about
the DB engine versions for these statuses. Valid statuses are the following:
available
deprecated
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 you can retrieve the remaining
results.
Default: 100
Constraints: Minimum 20, maximum 100.
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.
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 you can retrieve the remaining
results.
Default: 100
Constraints: Minimum 20, maximum 100.
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.
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 you can retrieve the remaining
results.
Default: 100
Constraints: Minimum 20, maximum 100.
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.
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
.
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
.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
.
MaxRecords
.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
.
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
.public void setDefaultOnly(Boolean defaultOnly)
Specifies whether to return only the default version of the specified engine or the engine and major version combination.
defaultOnly
- Specifies whether to return only the default version of the specified engine or the engine and major
version combination.public Boolean getDefaultOnly()
Specifies whether to return only the default version of the specified engine or the engine and major version combination.
public DescribeDBEngineVersionsRequest withDefaultOnly(Boolean defaultOnly)
Specifies whether to return only the default version of the specified engine or the engine and major version combination.
defaultOnly
- Specifies whether to return only the default version of the specified engine or the engine and major
version combination.public Boolean isDefaultOnly()
Specifies whether to return only the default version of the specified engine or the engine and major version combination.
public void setListSupportedCharacterSets(Boolean listSupportedCharacterSets)
Specifies whether to list the supported character sets for each engine version.
If this parameter is enabled and the requested engine supports the CharacterSetName
parameter for
CreateDBInstance
, the response includes a list of supported character sets for each engine version.
For RDS Custom, the default is not to list supported character sets. If you enable this parameter, RDS Custom returns no results.
listSupportedCharacterSets
- Specifies whether to list the supported character sets for each engine version.
If this parameter is enabled and the requested engine supports the CharacterSetName
parameter
for CreateDBInstance
, the response includes a list of supported character sets for each
engine version.
For RDS Custom, the default is not to list supported character sets. If you enable this parameter, RDS Custom returns no results.
public Boolean getListSupportedCharacterSets()
Specifies whether to list the supported character sets for each engine version.
If this parameter is enabled and the requested engine supports the CharacterSetName
parameter for
CreateDBInstance
, the response includes a list of supported character sets for each engine version.
For RDS Custom, the default is not to list supported character sets. If you enable this parameter, RDS Custom returns no results.
If this parameter is enabled and the requested engine supports the CharacterSetName
parameter for CreateDBInstance
, the response includes a list of supported character sets for
each engine version.
For RDS Custom, the default is not to list supported character sets. If you enable this parameter, RDS Custom returns no results.
public DescribeDBEngineVersionsRequest withListSupportedCharacterSets(Boolean listSupportedCharacterSets)
Specifies whether to list the supported character sets for each engine version.
If this parameter is enabled and the requested engine supports the CharacterSetName
parameter for
CreateDBInstance
, the response includes a list of supported character sets for each engine version.
For RDS Custom, the default is not to list supported character sets. If you enable this parameter, RDS Custom returns no results.
listSupportedCharacterSets
- Specifies whether to list the supported character sets for each engine version.
If this parameter is enabled and the requested engine supports the CharacterSetName
parameter
for CreateDBInstance
, the response includes a list of supported character sets for each
engine version.
For RDS Custom, the default is not to list supported character sets. If you enable this parameter, RDS Custom returns no results.
public Boolean isListSupportedCharacterSets()
Specifies whether to list the supported character sets for each engine version.
If this parameter is enabled and the requested engine supports the CharacterSetName
parameter for
CreateDBInstance
, the response includes a list of supported character sets for each engine version.
For RDS Custom, the default is not to list supported character sets. If you enable this parameter, RDS Custom returns no results.
If this parameter is enabled and the requested engine supports the CharacterSetName
parameter for CreateDBInstance
, the response includes a list of supported character sets for
each engine version.
For RDS Custom, the default is not to list supported character sets. If you enable this parameter, RDS Custom returns no results.
public void setListSupportedTimezones(Boolean listSupportedTimezones)
Specifies whether to list the supported time zones for each engine version.
If this parameter is enabled and the requested engine supports the TimeZone
parameter for
CreateDBInstance
, the response includes a list of supported time zones for each engine version.
For RDS Custom, the default is not to list supported time zones. If you enable this parameter, RDS Custom returns no results.
listSupportedTimezones
- Specifies whether to list the supported time zones for each engine version.
If this parameter is enabled and the requested engine supports the TimeZone
parameter for
CreateDBInstance
, the response includes a list of supported time zones for each engine
version.
For RDS Custom, the default is not to list supported time zones. If you enable this parameter, RDS Custom returns no results.
public Boolean getListSupportedTimezones()
Specifies whether to list the supported time zones for each engine version.
If this parameter is enabled and the requested engine supports the TimeZone
parameter for
CreateDBInstance
, the response includes a list of supported time zones for each engine version.
For RDS Custom, the default is not to list supported time zones. If you enable this parameter, RDS Custom returns no results.
If this parameter is enabled and the requested engine supports the TimeZone
parameter for
CreateDBInstance
, the response includes a list of supported time zones for each engine
version.
For RDS Custom, the default is not to list supported time zones. If you enable this parameter, RDS Custom returns no results.
public DescribeDBEngineVersionsRequest withListSupportedTimezones(Boolean listSupportedTimezones)
Specifies whether to list the supported time zones for each engine version.
If this parameter is enabled and the requested engine supports the TimeZone
parameter for
CreateDBInstance
, the response includes a list of supported time zones for each engine version.
For RDS Custom, the default is not to list supported time zones. If you enable this parameter, RDS Custom returns no results.
listSupportedTimezones
- Specifies whether to list the supported time zones for each engine version.
If this parameter is enabled and the requested engine supports the TimeZone
parameter for
CreateDBInstance
, the response includes a list of supported time zones for each engine
version.
For RDS Custom, the default is not to list supported time zones. If you enable this parameter, RDS Custom returns no results.
public Boolean isListSupportedTimezones()
Specifies whether to list the supported time zones for each engine version.
If this parameter is enabled and the requested engine supports the TimeZone
parameter for
CreateDBInstance
, the response includes a list of supported time zones for each engine version.
For RDS Custom, the default is not to list supported time zones. If you enable this parameter, RDS Custom returns no results.
If this parameter is enabled and the requested engine supports the TimeZone
parameter for
CreateDBInstance
, the response includes a list of supported time zones for each engine
version.
For RDS Custom, the default is not to list supported time zones. If you enable this parameter, RDS Custom returns no results.
public void setIncludeAll(Boolean includeAll)
Specifies whether to also list the engine versions that aren't available. The default is to list only available engine versions.
includeAll
- Specifies whether to also list the engine versions that aren't available. The default is to list only
available engine versions.public Boolean getIncludeAll()
Specifies whether to also list the engine versions that aren't available. The default is to list only available engine versions.
public DescribeDBEngineVersionsRequest withIncludeAll(Boolean includeAll)
Specifies whether to also list the engine versions that aren't available. The default is to list only available engine versions.
includeAll
- Specifies whether to also list the engine versions that aren't available. The default is to list only
available engine versions.public Boolean isIncludeAll()
Specifies whether to also list the engine versions that aren't available. The default is to list only available engine versions.
public String toString()
toString
in class Object
Object.toString()
public DescribeDBEngineVersionsRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()