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.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.Boolean	append
protected java.lang.String	entity
protected java.lang.Boolean	includeAudit
protected java.lang.String	newDescription
protected java.lang.String	newEntity
protected java.lang.Boolean	newFuzzyMatch
protected java.util.Map<java.lang.String,java.lang.Object>	newMetadata
protected java.util.List<CreateValue>	newValues
protected java.lang.String	workspaceId

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	UpdateEntityOptions(UpdateEntityOptions.Builder builder)

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Boolean	append() Gets the append.
java.lang.String	entity() Gets the entity.
java.lang.Boolean	includeAudit() Gets the includeAudit.
UpdateEntityOptions.Builder	newBuilder() New builder.
java.lang.String	newDescription() Gets the newDescription.
java.lang.String	newEntity() Gets the newEntity.
java.lang.Boolean	newFuzzyMatch() Gets the newFuzzyMatch.
java.util.Map<java.lang.String,java.lang.Object>	newMetadata() Gets the newMetadata.
java.util.List<CreateValue>	newValues() Gets the newValues.
java.lang.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

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

workspaceId

protected java.lang.String workspaceId

entity

protected java.lang.String entity

newEntity

protected java.lang.String newEntity

newDescription

protected java.lang.String newDescription

newMetadata

protected java.util.Map<java.lang.String,java.lang.Object> newMetadata

newFuzzyMatch

protected java.lang.Boolean newFuzzyMatch

newValues

protected java.util.List<CreateValue> newValues

append

protected java.lang.Boolean append

includeAudit

protected java.lang.Boolean includeAudit

Constructor Detail

UpdateEntityOptions

protected UpdateEntityOptions(UpdateEntityOptions.Builder builder)

Method Detail

newBuilder

public UpdateEntityOptions.Builder newBuilder()

New builder.

Returns:

a UpdateEntityOptions builder

workspaceId

public java.lang.String workspaceId()

Gets the workspaceId.

Unique identifier of the workspace.

Returns:

the workspaceId

entity

public java.lang.String entity()

Gets the entity.

The name of the entity.

Returns:

the entity

newEntity

public java.lang.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 java.lang.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 java.util.Map<java.lang.String,java.lang.Object> newMetadata()

Gets the newMetadata.

Any metadata related to the entity.

Returns:

the newMetadata

newFuzzyMatch

public java.lang.Boolean newFuzzyMatch()

Gets the newFuzzyMatch.

Whether to use fuzzy matching for the entity.

Returns:

the newFuzzyMatch

newValues

public java.util.List<CreateValue> newValues()

Gets the newValues.

An array of objects describing the entity values.

Returns:

the newValues

append

public java.lang.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 java.lang.Boolean includeAudit()

Gets the includeAudit.

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

Returns:

the includeAudit