com.ibm.watson.assistant.v1.model

Class UpdateEntityOptions

java.lang.Object

com.ibm.cloud.sdk.core.service.model.GenericModel

com.ibm.watson.assistant.v1.model.UpdateEntityOptions

All Implemented Interfaces:

com.ibm.cloud.sdk.core.service.model.ObjectModel

public class UpdateEntityOptions
extends com.ibm.cloud.sdk.core.service.model.GenericModel

The updateEntity options.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UpdateEntityOptions.Builder Builder.

Method Summary

Modifier and Type	Method and Description
Boolean	append() Gets the append.
String	entity() Gets the entity.
Boolean	includeAudit() Gets the includeAudit.
UpdateEntityOptions.Builder	newBuilder() New builder.
String	newDescription() Gets the newDescription.
String	newEntity() Gets the newEntity.
Boolean	newFuzzyMatch() Gets the newFuzzyMatch.
Map<String,Object>	newMetadata() Gets the newMetadata.
List<CreateValue>	newValues() Gets the newValues.
String	workspaceId() Gets the workspaceId.

Methods inherited from class com.ibm.cloud.sdk.core.service.model.GenericModel

equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

newBuilder

public UpdateEntityOptions.Builder newBuilder()

New builder.

Returns:

a UpdateEntityOptions 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

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-`.

Returns:

the newEntity

newDescription

public String newDescription()

Gets the newDescription.

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

Returns:

the newDescription

newMetadata

public Map<String,Object> newMetadata()

Gets the newMetadata.

Any metadata related to the entity.

Returns:

the newMetadata

newFuzzyMatch

public Boolean newFuzzyMatch()

Gets the newFuzzyMatch.

Whether to use fuzzy matching for the entity.

Returns:

the newFuzzyMatch

newValues

public List<CreateValue> newValues()

Gets the newValues.

An array of objects describing the entity values.

Returns:

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.

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