Package com.mypurecloud.sdk.v2.model

Class BotEntityValue

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

  • Constructor Details

    • BotEntityValue

      public BotEntityValue()

    • BotEntityValue

      public BotEntityValue(Boolean initWithEmptyList)

  • Method Details

    • name

      public BotEntityValue name(String name)
      The name of the entity.

    • getName

      public String getName()

    • setName

      public void setName(String name)

    • type

      public BotEntityValue type(BotEntityValue.TypeEnum type)
      The data type of the entity. Valid types include: String, Integer, Decimal, Boolean, Duration, Datetime, Currency, StringCollection, IntegerCollection, DecimalCollection, BooleanCollection, DurationCollection, DatetimeCollection, CurrencyCollection.

    • getType

      public BotEntityValue.TypeEnum getType()

    • setType

      public void setType(BotEntityValue.TypeEnum type)

    • value

      public BotEntityValue value(String value)
      The string value of the entity for simple types. Required when using non-collection types. Format depends on the 'type' field: String: \"any text\"; Integer: whole number (e.g., \"42\"); Decimal: number with optional decimal point (e.g., \"42.5\"); Boolean: \"true\" or \"false\"; Duration: ISO-8601 duration format (e.g., \"PT1H30M\" for 1 hour and 30 minutes); Datetime: ISO-8601 datetime format (e.g., \"2023-04-15T14:30:00Z\"); Currency: JSON object with 'amount' and 'code' fields as an escaped JSON string (e.g., \"{\\\"amount\\\":10.50,\\\"code\\\":\\\"USD\\\"}\" - note the escaped quotes).

    • getValue

      public String getValue()

    • setValue

      public void setValue(String value)

    • values

      public BotEntityValue values(List<String> values)
      The collection values for collection types. Required when using collection types. Each value must follow the format of its base type: StringCollection: array of strings; IntegerCollection: array of integer strings (e.g., [\"1\", \"2\", \"3\"]); DecimalCollection: array of decimal strings (e.g., [\"1.5\", \"2.0\", \"3.75\"]); BooleanCollection: array of boolean strings (e.g., [\"true\", \"false\"]); DurationCollection: array of ISO-8601 duration strings; DatetimeCollection: array of ISO-8601 datetime strings; CurrencyCollection: array of escaped JSON currency object strings (e.g., [\"{\\\"amount\\\":10.50,\\\"code\\\":\\\"USD\\\"}\", \"{\\\"amount\\\":25.00,\\\"code\\\":\\\"EUR\\\"}\"] - note the escaped quotes).

    • getValues

      public List<String> getValues()

    • setValues

      public void setValues(List<String> values)

    • 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