java.lang.Object
software.amazon.awssdk.services.dax.model.Parameter
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Parameter.Builder,Parameter>

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

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

See Also:
  • Method Details

    • parameterName

      public final String parameterName()

      The name of the parameter.

      Returns:
      The name of the parameter.
    • parameterType

      public final 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:
    • parameterTypeAsString

      public final 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:
    • parameterValue

      public final String 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 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.
    • nodeTypeSpecificValues

      public final 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.

      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

      public final String description()

      A description of the parameter

      Returns:
      A description of the parameter
    • source

      public final 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 final String dataType()

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

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

      public final 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 final 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:
    • isModifiableAsString

      public final 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:
    • changeType

      public final 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:
    • changeTypeAsString

      public final 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:
    • 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 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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.
    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.