Class Parameter
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Parameter.Builder,
Parameter>
Describes an individual setting that controls some aspect of DAX behavior.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
A range of values within which the parameter can be set.static Parameter.Builder
builder()
final ChangeType
The conditions under which changes to this parameter can be applied.final String
The conditions under which changes to this parameter can be applied.final String
dataType()
The data type of the parameter.final String
A description of the parameterfinal boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the NodeTypeSpecificValues property.final IsModifiable
Whether the customer is allowed to modify the parameter.final String
Whether the customer is allowed to modify the parameter.final List
<NodeTypeSpecificValue> A list of node types, and specific parameter values for each node.final String
The name of the parameter.final ParameterType
Determines whether the parameter can be applied to any nodes, or only nodes of a particular type.final String
Determines whether the parameter can be applied to any nodes, or only nodes of a particular type.final String
The value for the parameter.static Class
<? extends Parameter.Builder> final String
source()
How the parameter is defined.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
parameterName
The name of the parameter.
- Returns:
- The name of the parameter.
-
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 returnParameterType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromparameterTypeAsString()
.- Returns:
- Determines whether the parameter can be applied to any nodes, or only nodes of a particular type.
- See Also:
-
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 returnParameterType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromparameterTypeAsString()
.- Returns:
- Determines whether the parameter can be applied to any nodes, or only nodes of a particular type.
- See Also:
-
parameterValue
The value for the parameter.
- Returns:
- The value for the parameter.
-
hasNodeTypeSpecificValues
public final boolean hasNodeTypeSpecificValues()For responses, this returns true if the service returned a value for the NodeTypeSpecificValues property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
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.
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
hasNodeTypeSpecificValues()
method.- Returns:
- A list of node types, and specific parameter values for each node.
-
description
A description of the parameter
- Returns:
- A description of the parameter
-
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
The data type of the parameter. For example,
integer
:- Returns:
- The data type of the parameter. For example,
integer
:
-
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
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 returnIsModifiable.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromisModifiableAsString()
.- Returns:
- Whether the customer is allowed to modify the parameter.
- See Also:
-
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 returnIsModifiable.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromisModifiableAsString()
.- Returns:
- Whether the customer is allowed to modify the parameter.
- See Also:
-
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 returnChangeType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromchangeTypeAsString()
.- 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:
-
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 returnChangeType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromchangeTypeAsString()
.- 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:
-
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 interfaceToCopyableBuilder<Parameter.Builder,
Parameter> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-