software.amazon.awssdk.services.dax.model

Class Parameter

java.lang.Object

software.amazon.awssdk.services.dax.model.Parameter

All Implemented Interfaces:

StructuredPojo, ToCopyableBuilder<Parameter.Builder,Parameter>

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

Describes an individual setting that controls some aspect of DAX behavior.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Parameter.Builder

Method Summary

Modifier and Type	Method and Description
String	allowedValues() A range of values within which the parameter can be set.
static Parameter.Builder	builder()
ChangeType	changeType() The conditions under which changes to this parameter can be applied.
String	changeTypeAsString() The conditions under which changes to this parameter can be applied.
String	dataType() The data type of the parameter.
String	description() A description of the parameter
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
IsModifiable	isModifiable() Whether the customer is allowed to modify the parameter.
String	isModifiableAsString() Whether the customer is allowed to modify the parameter.
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
List<NodeTypeSpecificValue>	nodeTypeSpecificValues() A list of node types, and specific parameter values for each node.
String	parameterName() The name of the parameter.
ParameterType	parameterType() Determines whether the parameter can be applied to any nodes, or only nodes of a particular type.
String	parameterTypeAsString() Determines whether the parameter can be applied to any nodes, or only nodes of a particular type.
String	parameterValue() The value for the parameter.
static Class<? extends Parameter.Builder>	serializableBuilderClass()
String	source() How the parameter is defined.
Parameter.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

parameterName

public String parameterName()

The name of the parameter.

Returns:

The name of the parameter.

parameterType

public ParameterType parameterType()

Determines whether the parameter can be applied to any nodes, or only nodes of a particular type.

If the service returns an enum value that is not available in the current SDK version, parameterType will return ParameterType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from parameterTypeAsString().

Returns:

Determines whether the parameter can be applied to any nodes, or only nodes of a particular type.

See Also:

ParameterType

parameterTypeAsString

public String parameterTypeAsString()

Determines whether the parameter can be applied to any nodes, or only nodes of a particular type.

If the service returns an enum value that is not available in the current SDK version, parameterType will return ParameterType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from parameterTypeAsString().

Returns:

Determines whether the parameter can be applied to any nodes, or only nodes of a particular type.

See Also:

ParameterType

parameterValue

public String parameterValue()

The value for the parameter.

Returns:

The value for the parameter.

nodeTypeSpecificValues

public List<NodeTypeSpecificValue> nodeTypeSpecificValues()

A list of node types, and specific parameter values for each node.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

A list of node types, and specific parameter values for each node.

description

public String description()

A description of the parameter

Returns:

A description of the parameter

source

public String source()

How the parameter is defined. For example, system denotes a system-defined parameter.

Returns:

How the parameter is defined. For example, system denotes a system-defined parameter.

dataType

public String dataType()

The data type of the parameter. For example, integer:

Returns:

The data type of the parameter. For example, integer:

allowedValues

public String allowedValues()

A range of values within which the parameter can be set.

Returns:

A range of values within which the parameter can be set.

isModifiable

public IsModifiable isModifiable()

Whether the customer is allowed to modify the parameter.

If the service returns an enum value that is not available in the current SDK version, isModifiable will return IsModifiable.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from isModifiableAsString().

Returns:

Whether the customer is allowed to modify the parameter.

See Also:

IsModifiable

isModifiableAsString

public String isModifiableAsString()

Whether the customer is allowed to modify the parameter.

If the service returns an enum value that is not available in the current SDK version, isModifiable will return IsModifiable.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from isModifiableAsString().

Returns:

Whether the customer is allowed to modify the parameter.

See Also:

IsModifiable

changeType

public ChangeType changeType()

The conditions under which changes to this parameter can be applied. For example, requires-reboot indicates that a new value for this parameter will only take effect if a node is rebooted.

If the service returns an enum value that is not available in the current SDK version, changeType will return ChangeType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from changeTypeAsString().

Returns:

The conditions under which changes to this parameter can be applied. For example, requires-reboot indicates that a new value for this parameter will only take effect if a node is rebooted.

See Also:

ChangeType

changeTypeAsString

public String changeTypeAsString()

The conditions under which changes to this parameter can be applied. For example, requires-reboot indicates that a new value for this parameter will only take effect if a node is rebooted.

If the service returns an enum value that is not available in the current SDK version, changeType will return ChangeType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from changeTypeAsString().

Returns:

The conditions under which changes to this parameter can be applied. For example, requires-reboot indicates that a new value for this parameter will only take effect if a node is rebooted.

See Also:

ChangeType

toBuilder

public Parameter.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<Parameter.Builder,Parameter>

Returns:

a builder for type T

builder

public static Parameter.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.