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.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<DialogNodeAction>	actions
protected java.lang.String	conditions
protected java.util.Map<java.lang.String,java.lang.Object>	context
protected java.lang.String	description
protected java.lang.String	dialogNode
protected java.lang.String	digressIn
protected java.lang.String	digressOut
protected java.lang.String	digressOutSlots
protected java.lang.Boolean	disambiguationOptOut
protected java.lang.String	eventName
protected java.lang.Boolean	includeAudit
protected java.util.Map<java.lang.String,java.lang.Object>	metadata
protected DialogNodeNextStep	nextStep
protected DialogNodeOutput	output
protected java.lang.String	parent
protected java.lang.String	previousSibling
protected java.lang.String	title
protected java.lang.String	type
protected java.lang.String	userLabel
protected java.lang.String	variable
protected java.lang.String	workspaceId

Constructor Summary

Constructors

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

Method Summary

Methods

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

dialogNode

protected java.lang.String dialogNode

description

protected java.lang.String description

conditions

protected java.lang.String conditions

parent

protected java.lang.String parent

previousSibling

protected java.lang.String previousSibling

output

protected DialogNodeOutput output

context

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

metadata

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

nextStep

protected DialogNodeNextStep nextStep

title

protected java.lang.String title

type

protected java.lang.String type

eventName

protected java.lang.String eventName

variable

protected java.lang.String variable

actions

protected java.util.List<DialogNodeAction> actions

digressIn

protected java.lang.String digressIn

digressOut

protected java.lang.String digressOut

digressOutSlots

protected java.lang.String digressOutSlots

userLabel

protected java.lang.String userLabel

disambiguationOptOut

protected java.lang.Boolean disambiguationOptOut

includeAudit

protected java.lang.Boolean includeAudit

Constructor Detail

CreateDialogNodeOptions

protected CreateDialogNodeOptions(CreateDialogNodeOptions.Builder builder)

Method Detail

newBuilder

public CreateDialogNodeOptions.Builder newBuilder()

New builder.

Returns:

a CreateDialogNodeOptions builder

workspaceId

public java.lang.String workspaceId()

Gets the workspaceId.

Unique identifier of the workspace.

Returns:

the workspaceId

dialogNode

public java.lang.String dialogNode()

Gets the dialogNode.

The dialog node ID. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters.

Returns:

the dialogNode

description

public java.lang.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 java.lang.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 java.lang.String parent()

Gets the parent.

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

Returns:

the parent

previousSibling

public java.lang.String previousSibling()

Gets the previousSibling.

The 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 java.util.Map<java.lang.String,java.lang.Object> context()

Gets the context.

The context for the dialog node.

Returns:

the context

metadata

public java.util.Map<java.lang.String,java.lang.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 java.lang.String title()

Gets the title.

The alias used to identify the dialog node. This string must conform to the following restrictions: - It can contain only Unicode alphanumeric, space, underscore, hyphen, and dot characters.

Returns:

the title

type

public java.lang.String type()

Gets the type.

How the dialog node is processed.

Returns:

the type

eventName

public java.lang.String eventName()

Gets the eventName.

How an `event_handler` node is processed.

Returns:

the eventName

variable

public java.lang.String variable()

Gets the variable.

The location in the dialog context where output is stored.

Returns:

the variable

actions

public java.util.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 java.lang.String digressIn()

Gets the digressIn.

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

Returns:

the digressIn

digressOut

public java.lang.String digressOut()

Gets the digressOut.

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

Returns:

the digressOut

digressOutSlots

public java.lang.String digressOutSlots()

Gets the digressOutSlots.

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

Returns:

the digressOutSlots

userLabel

public java.lang.String userLabel()

Gets the userLabel.

A label that can be displayed externally to describe the purpose of the node to users.

Returns:

the userLabel

disambiguationOptOut

public java.lang.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 java.lang.Boolean includeAudit()

Gets the includeAudit.

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

Returns:

the includeAudit