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

Class DescribeDbEngineVersionsRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeDbEngineVersionsRequest.Builder,DescribeDbEngineVersionsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeDbEngineVersionsRequest.Builder

Method Summary

Modifier and Type	Method	Description
static DescribeDbEngineVersionsRequest.Builder	builder()
String	dbParameterGroupFamily()	The name of a specific DB parameter group family to return details for.
Boolean	defaultOnly()	Specifies whether to return only the default version of the specified engine or the engine and major version combination.
String	engine()	The database engine to return version details for.
String	engineVersion()	A specific database engine version to return details for.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<Filter>	filters()	A filter that specifies one or more DB engine versions to describe.
<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()
Boolean	includeAll()	Specifies whether to also list the engine versions that aren't available.
Boolean	listSupportedCharacterSets()	Specifies whether to list the supported character sets for each engine version.
Boolean	listSupportedTimezones()	Specifies whether to list the supported time zones for each engine version.
String	marker()	An optional pagination token provided by a previous request.
Integer	maxRecords()	The maximum number of records to include in the response.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeDbEngineVersionsRequest.Builder>	serializableBuilderClass()
DescribeDbEngineVersionsRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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 database engine to return version details for.

Valid Values:

• aurora-mysql

• aurora-postgresql

• custom-oracle-ee

• 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 database engine to return version details for.

Valid Values:

• aurora-mysql

• aurora-postgresql

• custom-oracle-ee

• 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 specific database engine version to return details for.

Example: 5.1.49

Returns:

A specific database engine version to return details for.

Example: 5.1.49

dbParameterGroupFamily

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

Returns:

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

Constraints:

• If supplied, must match an existing DB parameter group family.

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

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

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:

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

maxRecords

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

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 you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

marker

public final 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:

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.

defaultOnly

public final Boolean defaultOnly()

Specifies whether to return only the default version of the specified engine or the engine and major version combination.

Returns:

Specifies whether to return only the default version of the specified engine or the engine and major version combination.

listSupportedCharacterSets

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

Returns:

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.

listSupportedTimezones

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

Returns:

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.

includeAll

public final Boolean includeAll()

Specifies whether to also list the engine versions that aren't available. The default is to list only available engine versions.

Returns:

Specifies whether to also list the engine versions that aren't available. The default is to list only available engine versions.

toBuilder

public DescribeDbEngineVersionsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeDbEngineVersionsRequest.Builder,DescribeDbEngineVersionsRequest>

Specified by:

toBuilder in class RdsRequest

builder

public static DescribeDbEngineVersionsRequest.Builder builder()

serializableBuilderClass

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