com.ibm.watson.developer_cloud.conversation.v1.model

Class UpdateWorkspaceOptions

java.lang.Object

com.ibm.watson.developer_cloud.service.model.GenericModel

com.ibm.watson.developer_cloud.conversation.v1.model.UpdateWorkspaceOptions

All Implemented Interfaces:

ObjectModel

public class UpdateWorkspaceOptions
extends GenericModel

The updateWorkspace options.

Nested Class Summary

Nested Classes

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

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Boolean	append() Gets the append.
java.util.List<CreateCounterexample>	counterexamples() Gets the counterexamples.
java.lang.String	description() Gets the description.
java.util.List<CreateDialogNode>	dialogNodes() Gets the dialogNodes.
java.util.List<CreateEntity>	entities() Gets the entities.
java.util.List<CreateIntent>	intents() Gets the intents.
java.lang.String	language() Gets the language.
java.lang.Boolean	learningOptOut() Gets the learningOptOut.
java.util.Map	metadata() Gets the metadata.
java.lang.String	name() Gets the name.
UpdateWorkspaceOptions.Builder	newBuilder() New builder.
java.lang.String	workspaceId() Gets the workspaceId.

Methods inherited from class com.ibm.watson.developer_cloud.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 UpdateWorkspaceOptions.Builder newBuilder()

New builder.

Returns:

a UpdateWorkspaceOptions builder

workspaceId

public java.lang.String workspaceId()

Gets the workspaceId. Unique identifier of the workspace.

Returns:

the workspaceId

name

public java.lang.String name()

Gets the name. The name of the workspace. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 64 characters.

Returns:

the name

description

public java.lang.String description()

Gets the description. The description of the workspace. This string cannot contain carriage return, newline, or tab characters, and it must be no longer than 128 characters.

Returns:

the description

language

public java.lang.String language()

Gets the language. The language of the workspace.

Returns:

the language

intents

public java.util.List<CreateIntent> intents()

Gets the intents. An array of objects defining the intents for the workspace.

Returns:

the intents

entities

public java.util.List<CreateEntity> entities()

Gets the entities. An array of objects defining the entities for the workspace.

Returns:

the entities

dialogNodes

public java.util.List<CreateDialogNode> dialogNodes()

Gets the dialogNodes. An array of objects defining the nodes in the workspace dialog.

Returns:

the dialogNodes

counterexamples

public java.util.List<CreateCounterexample> counterexamples()

Gets the counterexamples. An array of objects defining input examples that have been marked as irrelevant input.

Returns:

the counterexamples

metadata

public java.util.Map metadata()

Gets the metadata. Any metadata related to the workspace.

Returns:

the metadata

learningOptOut

public java.lang.Boolean learningOptOut()

Gets the learningOptOut. Whether training data from the workspace can be used by IBM for general service improvements. `true` indicates that workspace training data is not to be used.

Returns:

the learningOptOut

append

public java.lang.Boolean append()

Gets the append. Whether the new data is to be appended to the existing data in the workspace. If **append**=`false`, elements included in the new data completely replace the corresponding existing elements, including all subelements. For example, if the new data includes **entities** and **append**=`false`, all existing entities in the workspace are discarded and replaced with the new entities. 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