Class Parameter

    • Constructor Detail

      • Parameter

        public Parameter()
    • Method Detail

      • setParameterName

        public void setParameterName​(String parameterName)

        Specifies the name of the parameter.

        Parameters:
        parameterName - Specifies the name of the parameter.
      • getParameterName

        public String getParameterName()

        Specifies the name of the parameter.

        Returns:
        Specifies the name of the parameter.
      • withParameterName

        public Parameter withParameterName​(String parameterName)

        Specifies the name of the parameter.

        Parameters:
        parameterName - Specifies the name of the parameter.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setParameterValue

        public void setParameterValue​(String parameterValue)

        Specifies the value of the parameter.

        Parameters:
        parameterValue - Specifies the value of the parameter.
      • getParameterValue

        public String getParameterValue()

        Specifies the value of the parameter.

        Returns:
        Specifies the value of the parameter.
      • withParameterValue

        public Parameter withParameterValue​(String parameterValue)

        Specifies the value of the parameter.

        Parameters:
        parameterValue - Specifies the value of the parameter.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setDescription

        public void setDescription​(String description)

        Provides a description of the parameter.

        Parameters:
        description - Provides a description of the parameter.
      • getDescription

        public String getDescription()

        Provides a description of the parameter.

        Returns:
        Provides a description of the parameter.
      • withDescription

        public Parameter withDescription​(String description)

        Provides a description of the parameter.

        Parameters:
        description - Provides 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)

        Indicates the source of the parameter value.

        Parameters:
        source - Indicates the source of the parameter value.
      • getSource

        public String getSource()

        Indicates the source of the parameter value.

        Returns:
        Indicates the source of the parameter value.
      • withSource

        public Parameter withSource​(String source)

        Indicates the source of the parameter value.

        Parameters:
        source - Indicates the source of the parameter value.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setApplyType

        public void setApplyType​(String applyType)

        Specifies the engine specific parameters type.

        Parameters:
        applyType - Specifies the engine specific parameters type.
      • getApplyType

        public String getApplyType()

        Specifies the engine specific parameters type.

        Returns:
        Specifies the engine specific parameters type.
      • withApplyType

        public Parameter withApplyType​(String applyType)

        Specifies the engine specific parameters type.

        Parameters:
        applyType - Specifies the engine specific parameters type.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setDataType

        public void setDataType​(String dataType)

        Specifies the valid data type for the parameter.

        Parameters:
        dataType - Specifies the valid data type for the parameter.
      • getDataType

        public String getDataType()

        Specifies the valid data type for the parameter.

        Returns:
        Specifies the valid data type for the parameter.
      • withDataType

        public Parameter withDataType​(String dataType)

        Specifies the valid data type for the parameter.

        Parameters:
        dataType - Specifies the valid data type for the parameter.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setAllowedValues

        public void setAllowedValues​(String allowedValues)

        Specifies the valid range of values for the parameter.

        Parameters:
        allowedValues - Specifies the valid range of values for the parameter.
      • getAllowedValues

        public String getAllowedValues()

        Specifies the valid range of values for the parameter.

        Returns:
        Specifies the valid range of values for the parameter.
      • withAllowedValues

        public Parameter withAllowedValues​(String allowedValues)

        Specifies the valid range of values for the parameter.

        Parameters:
        allowedValues - Specifies the valid range of values for the parameter.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setIsModifiable

        public void setIsModifiable​(Boolean isModifiable)

        Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

        Parameters:
        isModifiable - Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.
      • getIsModifiable

        public Boolean getIsModifiable()

        Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

        Returns:
        Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.
      • withIsModifiable

        public Parameter withIsModifiable​(Boolean isModifiable)

        Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

        Parameters:
        isModifiable - Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • isModifiable

        public Boolean isModifiable()

        Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

        Returns:
        Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.
      • setMinimumEngineVersion

        public void setMinimumEngineVersion​(String minimumEngineVersion)

        The earliest engine version to which the parameter can apply.

        Parameters:
        minimumEngineVersion - The earliest engine version to which the parameter can apply.
      • getMinimumEngineVersion

        public String getMinimumEngineVersion()

        The earliest engine version to which the parameter can apply.

        Returns:
        The earliest engine version to which the parameter can apply.
      • withMinimumEngineVersion

        public Parameter withMinimumEngineVersion​(String minimumEngineVersion)

        The earliest engine version to which the parameter can apply.

        Parameters:
        minimumEngineVersion - The earliest engine version to which the parameter can apply.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setApplyMethod

        public void setApplyMethod​(String applyMethod)

        Indicates when to apply parameter updates.

        Parameters:
        applyMethod - Indicates when to apply parameter updates.
        See Also:
        ApplyMethod
      • getApplyMethod

        public String getApplyMethod()

        Indicates when to apply parameter updates.

        Returns:
        Indicates when to apply parameter updates.
        See Also:
        ApplyMethod
      • withApplyMethod

        public Parameter withApplyMethod​(String applyMethod)

        Indicates when to apply parameter updates.

        Parameters:
        applyMethod - Indicates when to apply parameter updates.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ApplyMethod
      • setApplyMethod

        public void setApplyMethod​(ApplyMethod applyMethod)

        Indicates when to apply parameter updates.

        Parameters:
        applyMethod - Indicates when to apply parameter updates.
        See Also:
        ApplyMethod
      • withApplyMethod

        public Parameter withApplyMethod​(ApplyMethod applyMethod)

        Indicates when to apply parameter updates.

        Parameters:
        applyMethod - Indicates when to apply parameter updates.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ApplyMethod
      • 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()
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object