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.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	dialogNode
protected java.lang.Boolean	includeAudit
protected java.util.List<DialogNodeAction>	newActions
protected java.lang.String	newConditions
protected java.util.Map<java.lang.String,java.lang.Object>	newContext
protected java.lang.String	newDescription
protected java.lang.String	newDialogNode
protected java.lang.String	newDigressIn
protected java.lang.String	newDigressOut
protected java.lang.String	newDigressOutSlots
protected java.lang.Boolean	newDisambiguationOptOut
protected java.lang.String	newEventName
protected java.util.Map<java.lang.String,java.lang.Object>	newMetadata
protected DialogNodeNextStep	newNextStep
protected DialogNodeOutput	newOutput
protected java.lang.String	newParent
protected java.lang.String	newPreviousSibling
protected java.lang.String	newTitle
protected java.lang.String	newType
protected java.lang.String	newUserLabel
protected java.lang.String	newVariable
protected java.lang.String	workspaceId

Constructor Summary

Constructors

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

Method Summary

Methods

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

newDialogNode

protected java.lang.String newDialogNode

newDescription

protected java.lang.String newDescription

newConditions

protected java.lang.String newConditions

newParent

protected java.lang.String newParent

newPreviousSibling

protected java.lang.String newPreviousSibling

newOutput

protected DialogNodeOutput newOutput

newContext

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

newMetadata

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

newNextStep

protected DialogNodeNextStep newNextStep

newTitle

protected java.lang.String newTitle

newType

protected java.lang.String newType

newEventName

protected java.lang.String newEventName

newVariable

protected java.lang.String newVariable

newActions

protected java.util.List<DialogNodeAction> newActions

newDigressIn

protected java.lang.String newDigressIn

newDigressOut

protected java.lang.String newDigressOut

newDigressOutSlots

protected java.lang.String newDigressOutSlots

newUserLabel

protected java.lang.String newUserLabel

newDisambiguationOptOut

protected java.lang.Boolean newDisambiguationOptOut

includeAudit

protected java.lang.Boolean includeAudit

Constructor Detail

UpdateDialogNodeOptions

protected UpdateDialogNodeOptions(UpdateDialogNodeOptions.Builder builder)

Method Detail

newBuilder

public UpdateDialogNodeOptions.Builder newBuilder()

New builder.

Returns:

a UpdateDialogNodeOptions 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 (for example, `get_order`).

Returns:

the dialogNode

newDialogNode

public java.lang.String newDialogNode()

Gets the newDialogNode.

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 newDialogNode

newDescription

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

Gets the newParent.

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

Returns:

the newParent

newPreviousSibling

public java.lang.String newPreviousSibling()

Gets the newPreviousSibling.

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

Gets the newContext.

The context for the dialog node.

Returns:

the newContext

newMetadata

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

Gets the newTitle.

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 newTitle

newType

public java.lang.String newType()

Gets the newType.

How the dialog node is processed.

Returns:

the newType

newEventName

public java.lang.String newEventName()

Gets the newEventName.

How an `event_handler` node is processed.

Returns:

the newEventName

newVariable

public java.lang.String newVariable()

Gets the newVariable.

The location in the dialog context where output is stored.

Returns:

the newVariable

newActions

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

Gets the newDigressIn.

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

Returns:

the newDigressIn

newDigressOut

public java.lang.String newDigressOut()

Gets the newDigressOut.

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

Returns:

the newDigressOut

newDigressOutSlots

public java.lang.String newDigressOutSlots()

Gets the newDigressOutSlots.

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

Returns:

the newDigressOutSlots

newUserLabel

public java.lang.String newUserLabel()

Gets the newUserLabel.

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

Returns:

the newUserLabel

newDisambiguationOptOut

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

Gets the includeAudit.

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

Returns:

the includeAudit