com.ibm.watson.assistant.v1.model

Class CreateEntityOptions

java.lang.Object

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

com.ibm.watson.assistant.v1.model.CreateEntityOptions

All Implemented Interfaces:

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

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

The createEntity options.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
String	description() Gets the description.
String	entity() Gets the entity.
Boolean	fuzzyMatch() Gets the fuzzyMatch.
Boolean	includeAudit() Gets the includeAudit.
Map<String,Object>	metadata() Gets the metadata.
CreateEntityOptions.Builder	newBuilder() New builder.
List<CreateValue>	values() Gets the values.
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 CreateEntityOptions.Builder newBuilder()

New builder.

Returns:

a CreateEntityOptions 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. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, underscore, and hyphen characters. - If you specify an entity name beginning with the reserved prefix `sys-`, it must be the name of a system entity that you want to enable. (Any entity content specified with the request is ignored.).

Returns:

the entity

description

public String description()

Gets the description.

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

Returns:

the description

metadata

public Map<String,Object> metadata()

Gets the metadata.

Any metadata related to the entity.

Returns:

the metadata

fuzzyMatch

public Boolean fuzzyMatch()

Gets the fuzzyMatch.

Whether to use fuzzy matching for the entity.

Returns:

the fuzzyMatch

values

public List<CreateValue> values()

Gets the values.

An array of objects describing the entity values.

Returns:

the values

includeAudit

public Boolean includeAudit()

Gets the includeAudit.

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

Returns:

the includeAudit