software.amazon.awssdk.services.docdb.model

Class DBEngineVersion

java.lang.Object

software.amazon.awssdk.services.docdb.model.DBEngineVersion

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<DBEngineVersion.Builder,DBEngineVersion>

@Generated(value="software.amazon.awssdk:codegen")
public final class DBEngineVersion
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<DBEngineVersion.Builder,DBEngineVersion>

Detailed information about an engine version.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DBEngineVersion.Builder

Method Summary

Modifier and Type	Method and Description
static DBEngineVersion.Builder	builder()
String	dbEngineDescription() The description of the database engine.
String	dbEngineVersionDescription() The description of the database engine version.
String	dbParameterGroupFamily() The name of the parameter group family for the database engine.
String	engine() The name of the database engine.
String	engineVersion() The version number of the database engine.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<String>	exportableLogTypes() The types of logs that the database engine has available for export to Amazon CloudWatch Logs.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasExportableLogTypes() For responses, this returns true if the service returned a value for the ExportableLogTypes property.
int	hashCode()
boolean	hasValidUpgradeTarget() For responses, this returns true if the service returned a value for the ValidUpgradeTarget property.
List<SdkField<?>>	sdkFields()
static Class<? extends DBEngineVersion.Builder>	serializableBuilderClass()
Boolean	supportsLogExportsToCloudwatchLogs() A value that indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.
DBEngineVersion.Builder	toBuilder()
String	toString() Returns a string representation of this object.
List<UpgradeTarget>	validUpgradeTarget() A list of engine versions that this database engine version can be upgraded to.

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 name of the database engine.

Returns:

The name of the database engine.

engineVersion

public final String engineVersion()

The version number of the database engine.

Returns:

The version number of the database engine.

dbParameterGroupFamily

public final String dbParameterGroupFamily()

The name of the parameter group family for the database engine.

Returns:

The name of the parameter group family for the database engine.

dbEngineDescription

public final String dbEngineDescription()

The description of the database engine.

Returns:

The description of the database engine.

dbEngineVersionDescription

public final String dbEngineVersionDescription()

The description of the database engine version.

Returns:

The description of the database engine version.

hasValidUpgradeTarget

public final boolean hasValidUpgradeTarget()

For responses, this returns true if the service returned a value for the ValidUpgradeTarget 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.

validUpgradeTarget

public final List<UpgradeTarget> validUpgradeTarget()

A list of engine versions that this database engine version can be upgraded to.

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 hasValidUpgradeTarget() method.

Returns:

A list of engine versions that this database engine version can be upgraded to.

hasExportableLogTypes

public final boolean hasExportableLogTypes()

For responses, this returns true if the service returned a value for the ExportableLogTypes 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.

exportableLogTypes

public final List<String> exportableLogTypes()

The types of logs that the database engine has available for export to Amazon CloudWatch Logs.

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 hasExportableLogTypes() method.

Returns:

The types of logs that the database engine has available for export to Amazon CloudWatch Logs.

supportsLogExportsToCloudwatchLogs

public final Boolean supportsLogExportsToCloudwatchLogs()

A value that indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.

Returns:

A value that indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.

toBuilder

public DBEngineVersion.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DBEngineVersion.Builder,DBEngineVersion>

builder

public static DBEngineVersion.Builder builder()

serializableBuilderClass

public static Class<? extends DBEngineVersion.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo