Package software.amazon.awssdk.services.docdb.model

Class EngineDefaults

java.lang.Object

software.amazon.awssdk.services.docdb.model.EngineDefaults

All Implemented Interfaces:

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

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

Contains the result of a successful invocation of the DescribeEngineDefaultClusterParameters operation.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	EngineDefaults.Builder

Method Summary

Modifier and Type	Method	Description
static EngineDefaults.Builder	builder()
String	dbParameterGroupFamily()	The name of the cluster parameter group family to return the engine parameter information for.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasParameters()	For responses, this returns true if the service returned a value for the Parameters property.
String	marker()	An optional pagination token provided by a previous request.
List<Parameter>	parameters()	The parameters of a particular cluster parameter group family.
List<SdkField<?>>	sdkFields()
static Class<? extends EngineDefaults.Builder>	serializableBuilderClass()
EngineDefaults.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

dbParameterGroupFamily

public final String dbParameterGroupFamily()

The name of the cluster parameter group family to return the engine parameter information for.

Returns:

The name of the cluster parameter group family to return the engine parameter information for.

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.

hasParameters

public final boolean hasParameters()

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

parameters

public final List<Parameter> parameters()

The parameters of a particular cluster parameter group family.

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

Returns:

The parameters of a particular cluster parameter group family.

toBuilder

public EngineDefaults.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<EngineDefaults.Builder,EngineDefaults>

builder

public static EngineDefaults.Builder builder()

serializableBuilderClass

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