Package com.ibm.watson.assistant.v1.model

Class UpdateValueOptions

java.lang.Object
com.ibm.cloud.sdk.core.service.model.GenericModel
com.ibm.watson.assistant.v1.model.UpdateValueOptions
All Implemented Interfaces:
com.ibm.cloud.sdk.core.service.model.ObjectModel
public class UpdateValueOptions
extends com.ibm.cloud.sdk.core.service.model.GenericModel
The updateValue options.

  • Method Details

    • newBuilder

      public UpdateValueOptions.Builder newBuilder()
      New builder.
      Returns:
      a UpdateValueOptions builder

    • workspaceId

      public String workspaceId()
      Gets the workspaceId.

      Unique identifier of the workspace.

      Returns:
      the workspaceId

    • entity

      public String entity()
      Gets the entity.

      The name of the entity.

      Returns:
      the entity

    • value

      public String value()
      Gets the value.

      The text of the entity value.

      Returns:
      the value

    • newValue

      public String newValue()
      Gets the newValue.

      The text of the entity value. This string must conform to the following restrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters.

      Returns:
      the newValue

    • newMetadata

      public Map<String,​Object> newMetadata()
      Gets the newMetadata.

      Any metadata related to the entity value.

      Returns:
      the newMetadata

    • newType

      public String newType()
      Gets the newType.

      Specifies the type of entity value.

      Returns:
      the newType

    • newSynonyms

      public List<String> newSynonyms()
      Gets the newSynonyms.

      An array of synonyms for the entity value. A value can specify either synonyms or patterns (depending on the value type), but not both. A synonym must conform to the following resrictions: - It cannot contain carriage return, newline, or tab characters. - It cannot consist of only whitespace characters.

      Returns:
      the newSynonyms

    • newPatterns

      public List<String> newPatterns()
      Gets the newPatterns.

      An array of patterns for the entity value. A value can specify either synonyms or patterns (depending on the value type), but not both. A pattern is a regular expression; for more information about how to specify a pattern, see the [documentation](https://cloud.ibm.com/docs/assistant?topic=assistant-entities#entities-create-dictionary-based).

      Returns:
      the newPatterns

    • append

      public Boolean append()
      Gets the append.

      Whether the new data is to be appended to the existing data in the entity value. If **append**=`false`, elements included in the new data completely replace the corresponding existing elements, including all subelements. For example, if the new data for the entity value includes **synonyms** and **append**=`false`, all existing synonyms for the entity value are discarded and replaced with the new synonyms.

      If **append**=`true`, existing elements are preserved, and the new elements are added. If any elements in the new data collide with existing elements, the update request fails.

      Returns:
      the append

    • includeAudit

      public Boolean includeAudit()
      Gets the includeAudit.

      Whether to include the audit properties (`created` and `updated` timestamps) in the response.

      Returns:
      the includeAudit