Parameter (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.dax.model.Parameter

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Parameter
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Describes an individual setting that controls some aspect of DAX behavior.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Parameter()

Constructors
Constructor and Description
`Parameter()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Parameter`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getAllowedValues()` A range of values within which the parameter can be set.
`String`	`getChangeType()` The conditions under which changes to this parameter can be applied.
`String`	`getDataType()` The data type of the parameter.
`String`	`getDescription()` A description of the parameter
`String`	`getIsModifiable()` Whether the customer is allowed to modify the parameter.
`List<NodeTypeSpecificValue>`	`getNodeTypeSpecificValues()` A list of node types, and specific parameter values for each node.
`String`	`getParameterName()` The name of the parameter.
`String`	`getParameterType()` Determines whether the parameter can be applied to any nodes, or only nodes of a particular type.
`String`	`getParameterValue()` The value for the parameter.
`String`	`getSource()` How the parameter is defined.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAllowedValues(String allowedValues)` A range of values within which the parameter can be set.
`void`	`setChangeType(ChangeType changeType)` The conditions under which changes to this parameter can be applied.
`void`	`setChangeType(String changeType)` The conditions under which changes to this parameter can be applied.
`void`	`setDataType(String dataType)` The data type of the parameter.
`void`	`setDescription(String description)` A description of the parameter
`void`	`setIsModifiable(IsModifiable isModifiable)` Whether the customer is allowed to modify the parameter.
`void`	`setIsModifiable(String isModifiable)` Whether the customer is allowed to modify the parameter.
`void`	`setNodeTypeSpecificValues(Collection<NodeTypeSpecificValue> nodeTypeSpecificValues)` A list of node types, and specific parameter values for each node.
`void`	`setParameterName(String parameterName)` The name of the parameter.
`void`	`setParameterType(ParameterType parameterType)` Determines whether the parameter can be applied to any nodes, or only nodes of a particular type.
`void`	`setParameterType(String parameterType)` Determines whether the parameter can be applied to any nodes, or only nodes of a particular type.
`void`	`setParameterValue(String parameterValue)` The value for the parameter.
`void`	`setSource(String source)` How the parameter is defined.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`Parameter`	`withAllowedValues(String allowedValues)` A range of values within which the parameter can be set.
`Parameter`	`withChangeType(ChangeType changeType)` The conditions under which changes to this parameter can be applied.
`Parameter`	`withChangeType(String changeType)` The conditions under which changes to this parameter can be applied.
`Parameter`	`withDataType(String dataType)` The data type of the parameter.
`Parameter`	`withDescription(String description)` A description of the parameter
`Parameter`	`withIsModifiable(IsModifiable isModifiable)` Whether the customer is allowed to modify the parameter.
`Parameter`	`withIsModifiable(String isModifiable)` Whether the customer is allowed to modify the parameter.
`Parameter`	`withNodeTypeSpecificValues(Collection<NodeTypeSpecificValue> nodeTypeSpecificValues)` A list of node types, and specific parameter values for each node.
`Parameter`	`withNodeTypeSpecificValues(NodeTypeSpecificValue... nodeTypeSpecificValues)` A list of node types, and specific parameter values for each node.
`Parameter`	`withParameterName(String parameterName)` The name of the parameter.
`Parameter`	`withParameterType(ParameterType parameterType)` Determines whether the parameter can be applied to any nodes, or only nodes of a particular type.
`Parameter`	`withParameterType(String parameterType)` Determines whether the parameter can be applied to any nodes, or only nodes of a particular type.
`Parameter`	`withParameterValue(String parameterValue)` The value for the parameter.
`Parameter`	`withSource(String source)` How the parameter is defined.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Parameter
```
public Parameter()
```
- Method Detail
  - setParameterName
```
public void setParameterName(String parameterName)
```
    The name of the parameter.
    
    Parameters:
    
    parameterName - The name of the parameter.
  - getParameterName
```
public String getParameterName()
```
    The name of the parameter.
    
    Returns:
    
    The name of the parameter.
  - withParameterName
```
public Parameter withParameterName(String parameterName)
```
    The name of the parameter.
    
    Parameters:
    
    parameterName - The name of the parameter.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setParameterType
```
public void setParameterType(String parameterType)
```
    Determines whether the parameter can be applied to any nodes, or only nodes of a particular type.
    
    Parameters:
    
    parameterType - Determines whether the parameter can be applied to any nodes, or only nodes of a particular type.
    
    See Also:
    
    ParameterType
  - getParameterType
```
public String getParameterType()
```
    Determines whether the parameter can be applied to any nodes, or only nodes of a particular type.
    
    Returns:
    
    Determines whether the parameter can be applied to any nodes, or only nodes of a particular type.
    
    See Also:
    
    ParameterType
  - withParameterType
```
public Parameter withParameterType(String parameterType)
```
    Determines whether the parameter can be applied to any nodes, or only nodes of a particular type.
    
    Parameters:
    
    parameterType - Determines whether the parameter can be applied to any nodes, or only nodes of a particular type.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ParameterType
  - setParameterType
```
public void setParameterType(ParameterType parameterType)
```
    Determines whether the parameter can be applied to any nodes, or only nodes of a particular type.
    
    Parameters:
    
    parameterType - Determines whether the parameter can be applied to any nodes, or only nodes of a particular type.
    
    See Also:
    
    ParameterType
  - withParameterType
```
public Parameter withParameterType(ParameterType parameterType)
```
    Determines whether the parameter can be applied to any nodes, or only nodes of a particular type.
    
    Parameters:
    
    parameterType - Determines whether the parameter can be applied to any nodes, or only nodes of a particular type.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ParameterType
  - setParameterValue
```
public void setParameterValue(String parameterValue)
```
    The value for the parameter.
    
    Parameters:
    
    parameterValue - The value for the parameter.
  - getParameterValue
```
public String getParameterValue()
```
    The value for the parameter.
    
    Returns:
    
    The value for the parameter.
  - withParameterValue
```
public Parameter withParameterValue(String parameterValue)
```
    The value for the parameter.
    
    Parameters:
    
    parameterValue - The value for the parameter.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getNodeTypeSpecificValues
```
public List<NodeTypeSpecificValue> getNodeTypeSpecificValues()
```
    A list of node types, and specific parameter values for each node.
    
    Returns:
    
    A list of node types, and specific parameter values for each node.
  - setNodeTypeSpecificValues
```
public void setNodeTypeSpecificValues(Collection<NodeTypeSpecificValue> nodeTypeSpecificValues)
```
    A list of node types, and specific parameter values for each node.
    
    Parameters:
    
    nodeTypeSpecificValues - A list of node types, and specific parameter values for each node.
  - withNodeTypeSpecificValues
```
public Parameter withNodeTypeSpecificValues(NodeTypeSpecificValue... nodeTypeSpecificValues)
```
    A list of node types, and specific parameter values for each node.
    
    NOTE: This method appends the values to the existing list (if any). Use setNodeTypeSpecificValues(java.util.Collection) or withNodeTypeSpecificValues(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    nodeTypeSpecificValues - A list of node types, and specific parameter values for each node.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withNodeTypeSpecificValues
```
public Parameter withNodeTypeSpecificValues(Collection<NodeTypeSpecificValue> nodeTypeSpecificValues)
```
    A list of node types, and specific parameter values for each node.
    
    Parameters:
    
    nodeTypeSpecificValues - A list of node types, and specific parameter values for each node.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescription
```
public void setDescription(String description)
```
    A description of the parameter
    
    Parameters:
    
    description - A description of the parameter
  - getDescription
```
public String getDescription()
```
    A description of the parameter
    
    Returns:
    
    A description of the parameter
  - withDescription
```
public Parameter withDescription(String description)
```
    A description of the parameter
    
    Parameters:
    
    description - A description of the parameter
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSource
```
public void setSource(String source)
```
    How the parameter is defined. For example, system denotes a system-defined parameter.
    
    Parameters:
    
    source - How the parameter is defined. For example, system denotes a system-defined parameter.
  - getSource
```
public String getSource()
```
    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.
  - withSource
```
public Parameter withSource(String source)
```
    How the parameter is defined. For example, system denotes a system-defined parameter.
    
    Parameters:
    
    source - How the parameter is defined. For example, system denotes a system-defined parameter.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDataType
```
public void setDataType(String dataType)
```
    The data type of the parameter. For example, integer:
    
    Parameters:
    
    dataType - The data type of the parameter. For example, integer:
  - getDataType
```
public String getDataType()
```
    The data type of the parameter. For example, integer:
    
    Returns:
    
    The data type of the parameter. For example, integer:
  - withDataType
```
public Parameter withDataType(String dataType)
```
    The data type of the parameter. For example, integer:
    
    Parameters:
    
    dataType - The data type of the parameter. For example, integer:
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAllowedValues
```
public void setAllowedValues(String allowedValues)
```
    A range of values within which the parameter can be set.
    
    Parameters:
    
    allowedValues - A range of values within which the parameter can be set.
  - getAllowedValues
```
public String getAllowedValues()
```
    A range of values within which the parameter can be set.
    
    Returns:
    
    A range of values within which the parameter can be set.
  - withAllowedValues
```
public Parameter withAllowedValues(String allowedValues)
```
    A range of values within which the parameter can be set.
    
    Parameters:
    
    allowedValues - A range of values within which the parameter can be set.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIsModifiable
```
public void setIsModifiable(String isModifiable)
```
    Whether the customer is allowed to modify the parameter.
    
    Parameters:
    
    isModifiable - Whether the customer is allowed to modify the parameter.
    
    See Also:
    
    IsModifiable
  - getIsModifiable
```
public String getIsModifiable()
```
    Whether the customer is allowed to modify the parameter.
    
    Returns:
    
    Whether the customer is allowed to modify the parameter.
    
    See Also:
    
    IsModifiable
  - withIsModifiable
```
public Parameter withIsModifiable(String isModifiable)
```
    Whether the customer is allowed to modify the parameter.
    
    Parameters:
    
    isModifiable - Whether the customer is allowed to modify the parameter.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    IsModifiable
  - setIsModifiable
```
public void setIsModifiable(IsModifiable isModifiable)
```
    Whether the customer is allowed to modify the parameter.
    
    Parameters:
    
    isModifiable - Whether the customer is allowed to modify the parameter.
    
    See Also:
    
    IsModifiable
  - withIsModifiable
```
public Parameter withIsModifiable(IsModifiable isModifiable)
```
    Whether the customer is allowed to modify the parameter.
    
    Parameters:
    
    isModifiable - Whether the customer is allowed to modify the parameter.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    IsModifiable
  - setChangeType
```
public void setChangeType(String 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.
    
    Parameters:
    
    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.
    
    See Also:
    
    ChangeType
  - getChangeType
```
public String getChangeType()
```
    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.
    
    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
  - withChangeType
```
public Parameter withChangeType(String 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ChangeType
  - setChangeType
```
public void setChangeType(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.
    
    Parameters:
    
    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.
    
    See Also:
    
    ChangeType
  - withChangeType
```
public Parameter withChangeType(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ChangeType
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public Parameter clone()
```
    Overrides:
    
    clone in class Object
  - 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.

Did this page help you?

Class Parameter

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Parameter

Method Detail

setParameterName

getParameterName

withParameterName

setParameterType

getParameterType

withParameterType

setParameterType

withParameterType

setParameterValue

getParameterValue

withParameterValue

getNodeTypeSpecificValues

setNodeTypeSpecificValues

withNodeTypeSpecificValues

withNodeTypeSpecificValues

setDescription

getDescription

withDescription

setSource

getSource

withSource

setDataType

getDataType

withDataType

setAllowedValues

getAllowedValues

withAllowedValues

setIsModifiable

getIsModifiable

withIsModifiable

setIsModifiable

withIsModifiable

setChangeType

getChangeType

withChangeType

setChangeType

withChangeType

toString

equals

hashCode

clone

marshall