Package com.mypurecloud.sdk.v2.model

Class Variable

java.lang.Object
com.mypurecloud.sdk.v2.model.Variable
All Implemented Interfaces:
Serializable
public class Variable extends Object implements Serializable
Variable
See Also:

  • Constructor Details

    • Variable

      public Variable()

    • Variable

      public Variable(Boolean initWithEmptyList)

  • Method Details

    • name

      public Variable name(String name)
      The name of the variable.

    • getName

      public String getName()

    • setName

      public void setName(String name)

    • type

      public Variable type(Variable.TypeEnum type)
      The data type of the variable.

    • getType

      public Variable.TypeEnum getType()

    • setType

      public void setType(Variable.TypeEnum type)

    • scope

      public Variable scope(Variable.ScopeEnum scope)
      The scope that determines the variable's usage context within Guides runtime.

    • getScope

      public Variable.ScopeEnum getScope()

    • setScope

      public void setScope(Variable.ScopeEnum scope)

    • description

      public Variable description(String description)
      The description of the variable used by Guides runtime for input/output handling.

    • getDescription

      public String getDescription()

    • setDescription

      public void setDescription(String description)

    • validation

      public Variable validation(Object validation)
      The validation configuration for the variable. Optional - if not present, no validation is applied.

    • getValidation

      public Object getValidation()

    • setValidation

      public void setValidation(Object validation)

    • listValues

      public Variable listValues(Object listValues)
      The values configuration for List variables. Only applicable when type is 'List'.

    • getListValues

      public Object getListValues()

    • setListValues

      public void setListValues(Object listValues)

    • listVariables

      public Variable listVariables(List<Variable> listVariables)
      The variables that the list result will be stored in. Only applicable when type is 'List'.

    • getListVariables

      public List<Variable> getListVariables()

    • setListVariables

      public void setListVariables(List<Variable> listVariables)

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object