com.ibm.watson.assistant.v1.model

Class CreateValueOptions

java.lang.Object

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

com.ibm.watson.assistant.v1.model.CreateValueOptions

All Implemented Interfaces:

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

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

The createValue options.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CreateValueOptions.Builder Builder.
static interface	CreateValueOptions.ValueType Specifies the type of entity value.

Method Summary

Modifier and Type	Method and Description
java.lang.String	entity() Gets the entity.
java.util.Map<java.lang.String,java.lang.Object>	metadata() Gets the metadata.
CreateValueOptions.Builder	newBuilder() New builder.
java.util.List<java.lang.String>	patterns() Gets the patterns.
java.util.List<java.lang.String>	synonyms() Gets the synonyms.
java.lang.String	value() Gets the value.
java.lang.String	valueType() Gets the valueType.
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

Method Detail

newBuilder

public CreateValueOptions.Builder newBuilder()

New builder.

Returns:

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

value

public java.lang.String value()

Gets the value. 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 value

metadata

public java.util.Map<java.lang.String,java.lang.Object> metadata()

Gets the metadata. Any metadata related to the entity value.

Returns:

the metadata

valueType

public java.lang.String valueType()

Gets the valueType. Specifies the type of entity value.

Returns:

the valueType

synonyms

public java.util.List<java.lang.String> synonyms()

Gets the synonyms. 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 synonyms

patterns

public java.util.List<java.lang.String> patterns()

Gets the patterns. 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/services/assistant?topic=assistant-entities#entities-create-dictionary-based).

Returns:

the patterns