com.ibm.watson.assistant.v1.model

Class Workspace

java.lang.Object

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

com.ibm.watson.assistant.v1.model.Workspace

All Implemented Interfaces:

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

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

Workspace.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Workspace.Status The current status of the workspace: - **Available**: The workspace is available and ready to process messages.

Method Summary

Modifier and Type	Method and Description
List<Counterexample>	getCounterexamples() Gets the counterexamples.
WorkspaceCounts	getCounts() Gets the counts.
Date	getCreated() Gets the created.
String	getDescription() Gets the description.
List<DialogNode>	getDialogNodes() Gets the dialogNodes.
List<Entity>	getEntities() Gets the entities.
List<Intent>	getIntents() Gets the intents.
String	getLanguage() Gets the language.
Map<String,Object>	getMetadata() Gets the metadata.
String	getName() Gets the name.
String	getStatus() Gets the status.
List<StatusError>	getStatusErrors() Gets the statusErrors.
WorkspaceSystemSettings	getSystemSettings() Gets the systemSettings.
Date	getUpdated() Gets the updated.
List<Webhook>	getWebhooks() Gets the webhooks.
String	getWorkspaceId() Gets the workspaceId.
Boolean	isLearningOptOut() Gets the learningOptOut.

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

getName

public String getName()

Gets the name.

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

Returns:

the name

getDescription

public String getDescription()

Gets the description.

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

Returns:

the description

getLanguage

public String getLanguage()

Gets the language.

The language of the workspace.

Returns:

the language

getWorkspaceId

public String getWorkspaceId()

Gets the workspaceId.

The workspace ID of the workspace.

Returns:

the workspaceId

getDialogNodes

public List<DialogNode> getDialogNodes()

Gets the dialogNodes.

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

Returns:

the dialogNodes

getCounterexamples

public List<Counterexample> getCounterexamples()

Gets the counterexamples.

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

Returns:

the counterexamples

getCreated

public Date getCreated()

Gets the created.

The timestamp for creation of the object.

Returns:

the created

getUpdated

public Date getUpdated()

Gets the updated.

The timestamp for the most recent update to the object.

Returns:

the updated

getMetadata

public Map<String,Object> getMetadata()

Gets the metadata.

Any metadata related to the workspace.

Returns:

the metadata

isLearningOptOut

public Boolean isLearningOptOut()

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

getSystemSettings

public WorkspaceSystemSettings getSystemSettings()

Gets the systemSettings.

Global settings for the workspace.

Returns:

the systemSettings

getStatus

public String getStatus()

Gets the status.

The current status of the workspace: - **Available**: The workspace is available and ready to process messages. - **Failed**: An asynchronous operation has failed. See the **status_errors** property for more information about the cause of the failure. - **Non Existent**: The workspace does not exist. - **Processing**: An asynchronous operation has not yet completed. - **Training**: The workspace is training based on new data such as intents or examples.

Returns:

the status

getStatusErrors

public List<StatusError> getStatusErrors()

Gets the statusErrors.

An array of messages about errors that caused an asynchronous operation to fail.

Returns:

the statusErrors

getWebhooks

public List<Webhook> getWebhooks()

Gets the webhooks.

Returns:

the webhooks

getIntents

public List<Intent> getIntents()

Gets the intents.

An array of intents.

Returns:

the intents

getEntities

public List<Entity> getEntities()

Gets the entities.

An array of objects describing the entities for the workspace.

Returns:

the entities

getCounts

public WorkspaceCounts getCounts()

Gets the counts.

An object containing properties that indicate how many intents, entities, and dialog nodes are defined in the workspace. This property is included only in responses from the **Export workspace asynchronously** method, and only when the **verbose** query parameter is set to `true`.

Returns:

the counts