com.ibm.watson.assistant.v1.model

Class CreateDialogNodeOptions

java.lang.Object

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

com.ibm.watson.assistant.v1.model.CreateDialogNodeOptions

All Implemented Interfaces:

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

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

The createDialogNode options.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CreateDialogNodeOptions.Builder Builder.
static interface	CreateDialogNodeOptions.DigressIn Whether this top-level dialog node can be digressed into.
static interface	CreateDialogNodeOptions.DigressOut Whether this dialog node can be returned to after a digression.
static interface	CreateDialogNodeOptions.DigressOutSlots Whether the user can digress to top-level nodes while filling out slots.
static interface	CreateDialogNodeOptions.EventName How an `event_handler` node is processed.
static interface	CreateDialogNodeOptions.Type How the dialog node is processed.

Method Summary

Modifier and Type	Method and Description
List<DialogNodeAction>	actions() Gets the actions.
String	conditions() Gets the conditions.
DialogNodeContext	context() Gets the context.
String	description() Gets the description.
String	dialogNode() Gets the dialogNode.
String	digressIn() Gets the digressIn.
String	digressOut() Gets the digressOut.
String	digressOutSlots() Gets the digressOutSlots.
Boolean	disambiguationOptOut() Gets the disambiguationOptOut.
String	eventName() Gets the eventName.
Boolean	includeAudit() Gets the includeAudit.
Map<String,Object>	metadata() Gets the metadata.
CreateDialogNodeOptions.Builder	newBuilder() New builder.
DialogNodeNextStep	nextStep() Gets the nextStep.
DialogNodeOutput	output() Gets the output.
String	parent() Gets the parent.
String	previousSibling() Gets the previousSibling.
String	title() Gets the title.
String	type() Gets the type.
String	userLabel() Gets the userLabel.
String	variable() Gets the variable.
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 CreateDialogNodeOptions.Builder newBuilder()

New builder.

Returns:

a CreateDialogNodeOptions builder

workspaceId

public String workspaceId()

Gets the workspaceId.

Unique identifier of the workspace.

Returns:

the workspaceId

dialogNode

public String dialogNode()

Gets the dialogNode.

The unique ID of the dialog node. This is an internal identifier used to refer to the dialog node from other dialog nodes and in the diagnostic information included with message responses.

This string can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters.

Returns:

the dialogNode

description

public String description()

Gets the description.

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

Returns:

the description

conditions

public String conditions()

Gets the conditions.

The condition that will trigger the dialog node. This string cannot contain carriage return, newline, or tab characters.

Returns:

the conditions

parent

public String parent()

Gets the parent.

The unique ID of the parent dialog node. This property is omitted if the dialog node has no parent.

Returns:

the parent

previousSibling

public String previousSibling()

Gets the previousSibling.

The unique ID of the previous sibling dialog node. This property is omitted if the dialog node has no previous sibling.

Returns:

the previousSibling

output

public DialogNodeOutput output()

Gets the output.

The output of the dialog node. For more information about how to specify dialog node output, see the [documentation](https://cloud.ibm.com/docs/assistant?topic=assistant-dialog-overview#dialog-overview-responses).

Returns:

the output

context

public DialogNodeContext context()

Gets the context.

The context for the dialog node.

Returns:

the context

metadata

public Map<String,Object> metadata()

Gets the metadata.

The metadata for the dialog node.

Returns:

the metadata

nextStep

public DialogNodeNextStep nextStep()

Gets the nextStep.

The next step to execute following this dialog node.

Returns:

the nextStep

title

public String title()

Gets the title.

A human-readable name for the dialog node. If the node is included in disambiguation, this title is used to populate the **label** property of the corresponding suggestion in the `suggestion` response type (unless it is overridden by the **user_label** property). The title is also used to populate the **topic** property in the `connect_to_agent` response type.

This string can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters.

Returns:

the title

type

public String type()

Gets the type.

How the dialog node is processed.

Returns:

the type

eventName

public String eventName()

Gets the eventName.

How an `event_handler` node is processed.

Returns:

the eventName

variable

public String variable()

Gets the variable.

The location in the dialog context where output is stored.

Returns:

the variable

actions

public List<DialogNodeAction> actions()

Gets the actions.

An array of objects describing any actions to be invoked by the dialog node.

Returns:

the actions

digressIn

public String digressIn()

Gets the digressIn.

Whether this top-level dialog node can be digressed into.

Returns:

the digressIn

digressOut

public String digressOut()

Gets the digressOut.

Whether this dialog node can be returned to after a digression.

Returns:

the digressOut

digressOutSlots

public String digressOutSlots()

Gets the digressOutSlots.

Whether the user can digress to top-level nodes while filling out slots.

Returns:

the digressOutSlots

userLabel

public String userLabel()

Gets the userLabel.

A label that can be displayed externally to describe the purpose of the node to users. If set, this label is used to identify the node in disambiguation responses (overriding the value of the **title** property).

Returns:

the userLabel

disambiguationOptOut

public Boolean disambiguationOptOut()

Gets the disambiguationOptOut.

Whether the dialog node should be excluded from disambiguation suggestions. Valid only when **type**=`standard` or `frame`.

Returns:

the disambiguationOptOut

includeAudit

public Boolean includeAudit()

Gets the includeAudit.

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

Returns:

the includeAudit