Package software.amazon.awssdk.services.dax.model

Class Parameter

    • Method Detail

      • 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:
        ParameterType

      • 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:
        ParameterType

      • 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.

      • 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:
        IsModifiable

      • 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:
        ChangeType

      • 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:
        ChangeType

      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object

      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object

      • 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)