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.Type Specifies the type of entity value.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	entity
protected java.lang.Boolean	includeAudit
protected java.util.Map<java.lang.String,java.lang.Object>	metadata
protected java.util.List<java.lang.String>	patterns
protected java.util.List<java.lang.String>	synonyms
protected java.lang.String	type
protected java.lang.String	value
protected java.lang.String	workspaceId

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	entity() Gets the entity.
java.lang.Boolean	includeAudit() Gets the includeAudit.
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	type() Gets the type.
java.lang.String	value() Gets the value.
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

value

protected java.lang.String value

metadata

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

type

protected java.lang.String type

synonyms

protected java.util.List<java.lang.String> synonyms

patterns

protected java.util.List<java.lang.String> patterns

includeAudit

protected java.lang.Boolean includeAudit

Constructor Detail

CreateValueOptions

protected CreateValueOptions(CreateValueOptions.Builder builder)

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

type

public java.lang.String type()

Gets the type.

Specifies the type of entity value.

Returns:

the type

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

Returns:

the patterns

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