Class UpdateEntityOptions

All Implemented Interfaces:

public class UpdateEntityOptions
The updateEntity options.
  • Method Details

    • newBuilder

      public UpdateEntityOptions.Builder newBuilder()
      New builder.
      a UpdateEntityOptions builder
    • workspaceId

      public String workspaceId()
      Gets the workspaceId.

      Unique identifier of the workspace.

      the workspaceId
    • entity

      public String entity()
      Gets the entity.

      The name of the entity.

      the entity
    • newEntity

      public String newEntity()
      Gets the newEntity.

      The name of the entity. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, underscore, and hyphen characters. - It cannot begin with the reserved prefix `sys-`.

      the newEntity
    • newDescription

      public String newDescription()
      Gets the newDescription.

      The description of the entity. This string cannot contain carriage return, newline, or tab characters.

      the newDescription
    • newMetadata

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

      Any metadata related to the entity.

      the newMetadata
    • newFuzzyMatch

      public Boolean newFuzzyMatch()
      Gets the newFuzzyMatch.

      Whether to use fuzzy matching for the entity.

      the newFuzzyMatch
    • newValues

      public List<CreateValue> newValues()
      Gets the newValues.

      An array of objects describing the entity values.

      the newValues
    • append

      public Boolean append()
      Gets the append.

      Whether the new data is to be appended to the existing data in the entity. 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 includes **values** and **append**=`false`, all existing values for the entity are discarded and replaced with the new values.

      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.

      the append
    • includeAudit

      public Boolean includeAudit()
      Gets the includeAudit.

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

      the includeAudit