com.ibm.watson.assistant.v1.model

Class UpdateWorkspaceOptions

java.lang.Object

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

com.ibm.watson.assistant.v1.model.UpdateWorkspaceOptions

All Implemented Interfaces:

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

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

The updateWorkspace options.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
Boolean	append() Gets the append.
List<Counterexample>	counterexamples() Gets the counterexamples.
String	description() Gets the description.
List<DialogNode>	dialogNodes() Gets the dialogNodes.
List<CreateEntity>	entities() Gets the entities.
Boolean	includeAudit() Gets the includeAudit.
List<CreateIntent>	intents() Gets the intents.
String	language() Gets the language.
Boolean	learningOptOut() Gets the learningOptOut.
Map<String,Object>	metadata() Gets the metadata.
String	name() Gets the name.
UpdateWorkspaceOptions.Builder	newBuilder() New builder.
WorkspaceSystemSettings	systemSettings() Gets the systemSettings.
List<Webhook>	webhooks() Gets the webhooks.
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 UpdateWorkspaceOptions.Builder newBuilder()

New builder.

Returns:

a UpdateWorkspaceOptions builder

workspaceId

public String workspaceId()

Gets the workspaceId.

Unique identifier of the workspace.

Returns:

the workspaceId

name

public String name()

Gets the name.

The name of the workspace. This string cannot contain carriage return, newline, or tab characters.

Returns:

the name

description

public String description()

Gets the description.

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

Returns:

the description

language

public String language()

Gets the language.

The language of the workspace.

Returns:

the language

dialogNodes

public List<DialogNode> dialogNodes()

Gets the dialogNodes.

An array of objects describing the dialog nodes in the workspace.

Returns:

the dialogNodes

counterexamples

public List<Counterexample> counterexamples()

Gets the counterexamples.

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

Returns:

the counterexamples

metadata

public Map<String,Object> metadata()

Gets the metadata.

Any metadata related to the workspace.

Returns:

the metadata

learningOptOut

public Boolean learningOptOut()

Gets the learningOptOut.

Whether training data from the workspace (including artifacts such as intents and entities) can be used by IBM for general service improvements. `true` indicates that workspace training data is not to be used.

Returns:

the learningOptOut

systemSettings

public WorkspaceSystemSettings systemSettings()

Gets the systemSettings.

Global settings for the workspace.

Returns:

the systemSettings

webhooks

public List<Webhook> webhooks()

Gets the webhooks.

Returns:

the webhooks

intents

public List<CreateIntent> intents()

Gets the intents.

An array of objects defining the intents for the workspace.

Returns:

the intents

entities

public List<CreateEntity> entities()

Gets the entities.

An array of objects describing the entities for the workspace.

Returns:

the entities

append

public Boolean append()

Gets the append.

Whether the new data is to be appended to the existing data in the object. 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 a workspace 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

includeAudit

public Boolean includeAudit()

Gets the includeAudit.

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

Returns:

the includeAudit