com.ibm.watson.assistant.v1.model

Class UpdateDialogNodeOptions

java.lang.Object

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

com.ibm.watson.assistant.v1.model.UpdateDialogNodeOptions

All Implemented Interfaces:

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

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

The updateDialogNode options.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UpdateDialogNodeOptions.Builder Builder.
static interface	UpdateDialogNodeOptions.NewDigressIn Whether this top-level dialog node can be digressed into.
static interface	UpdateDialogNodeOptions.NewDigressOut Whether this dialog node can be returned to after a digression.
static interface	UpdateDialogNodeOptions.NewDigressOutSlots Whether the user can digress to top-level nodes while filling out slots.
static interface	UpdateDialogNodeOptions.NewEventName How an `event_handler` node is processed.
static interface	UpdateDialogNodeOptions.NewType How the dialog node is processed.

Method Summary

Modifier and Type	Method and Description
String	dialogNode() Gets the dialogNode.
Boolean	includeAudit() Gets the includeAudit.
List<DialogNodeAction>	newActions() Gets the newActions.
UpdateDialogNodeOptions.Builder	newBuilder() New builder.
String	newConditions() Gets the newConditions.
DialogNodeContext	newContext() Gets the newContext.
String	newDescription() Gets the newDescription.
String	newDialogNode() Gets the newDialogNode.
String	newDigressIn() Gets the newDigressIn.
String	newDigressOut() Gets the newDigressOut.
String	newDigressOutSlots() Gets the newDigressOutSlots.
Boolean	newDisambiguationOptOut() Gets the newDisambiguationOptOut.
String	newEventName() Gets the newEventName.
Map<String,Object>	newMetadata() Gets the newMetadata.
DialogNodeNextStep	newNextStep() Gets the newNextStep.
DialogNodeOutput	newOutput() Gets the newOutput.
String	newParent() Gets the newParent.
String	newPreviousSibling() Gets the newPreviousSibling.
String	newTitle() Gets the newTitle.
String	newType() Gets the newType.
String	newUserLabel() Gets the newUserLabel.
String	newVariable() Gets the newVariable.
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 UpdateDialogNodeOptions.Builder newBuilder()

New builder.

Returns:

a UpdateDialogNodeOptions builder

workspaceId

public String workspaceId()

Gets the workspaceId.

Unique identifier of the workspace.

Returns:

the workspaceId

dialogNode

public String dialogNode()

Gets the dialogNode.

The dialog node ID (for example, `node_1_1479323581900`).

Returns:

the dialogNode

newDialogNode

public String newDialogNode()

Gets the newDialogNode.

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 newDialogNode

newDescription

public String newDescription()

Gets the newDescription.

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

Returns:

the newDescription

newConditions

public String newConditions()

Gets the newConditions.

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

Returns:

the newConditions

newParent

public String newParent()

Gets the newParent.

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

Returns:

the newParent

newPreviousSibling

public String newPreviousSibling()

Gets the newPreviousSibling.

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

Returns:

the newPreviousSibling

newOutput

public DialogNodeOutput newOutput()

Gets the newOutput.

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 newOutput

newContext

public DialogNodeContext newContext()

Gets the newContext.

The context for the dialog node.

Returns:

the newContext

newMetadata

public Map<String,Object> newMetadata()

Gets the newMetadata.

The metadata for the dialog node.

Returns:

the newMetadata

newNextStep

public DialogNodeNextStep newNextStep()

Gets the newNextStep.

The next step to execute following this dialog node.

Returns:

the newNextStep

newTitle

public String newTitle()

Gets the newTitle.

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 newTitle

newType

public String newType()

Gets the newType.

How the dialog node is processed.

Returns:

the newType

newEventName

public String newEventName()

Gets the newEventName.

How an `event_handler` node is processed.

Returns:

the newEventName

newVariable

public String newVariable()

Gets the newVariable.

The location in the dialog context where output is stored.

Returns:

the newVariable

newActions

public List<DialogNodeAction> newActions()

Gets the newActions.

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

Returns:

the newActions

newDigressIn

public String newDigressIn()

Gets the newDigressIn.

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

Returns:

the newDigressIn

newDigressOut

public String newDigressOut()

Gets the newDigressOut.

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

Returns:

the newDigressOut

newDigressOutSlots

public String newDigressOutSlots()

Gets the newDigressOutSlots.

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

Returns:

the newDigressOutSlots

newUserLabel

public String newUserLabel()

Gets the newUserLabel.

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 newUserLabel

newDisambiguationOptOut

public Boolean newDisambiguationOptOut()

Gets the newDisambiguationOptOut.

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

Returns:

the newDisambiguationOptOut

includeAudit

public Boolean includeAudit()

Gets the includeAudit.

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

Returns:

the includeAudit