com.ibm.watson.assistant.v1.model

Class RuntimeResponseGeneric

java.lang.Object

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

com.ibm.watson.assistant.v1.model.RuntimeResponseGeneric

All Implemented Interfaces:

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

Direct Known Subclasses:

RuntimeResponseGenericRuntimeResponseTypeConnectToAgent, RuntimeResponseGenericRuntimeResponseTypeImage, RuntimeResponseGenericRuntimeResponseTypeOption, RuntimeResponseGenericRuntimeResponseTypePause, RuntimeResponseGenericRuntimeResponseTypeSuggestion, RuntimeResponseGenericRuntimeResponseTypeText

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

RuntimeResponseGeneric.

Classes which extend this class: - RuntimeResponseGenericRuntimeResponseTypeText - RuntimeResponseGenericRuntimeResponseTypePause - RuntimeResponseGenericRuntimeResponseTypeImage - RuntimeResponseGenericRuntimeResponseTypeOption - RuntimeResponseGenericRuntimeResponseTypeConnectToAgent - RuntimeResponseGenericRuntimeResponseTypeSuggestion

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RuntimeResponseGeneric.Preference The preferred type of control to display.
static interface	RuntimeResponseGeneric.ResponseType The type of response returned by the dialog node.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	agentAvailable
protected java.lang.String	agentUnavailable
protected java.lang.String	description
protected java.lang.String	dialogNode
protected static java.util.Map<java.lang.String,java.lang.Class<?>>	discriminatorMapping
protected static java.lang.String	discriminatorPropertyName
protected java.lang.String	messageToHumanAgent
protected java.util.List<DialogNodeOutputOptionsElement>	options
protected java.lang.String	preference
protected java.lang.String	responseType
protected java.lang.String	source
protected java.util.List<DialogSuggestion>	suggestions
protected java.lang.String	text
protected java.lang.Long	time
protected java.lang.String	title
protected java.lang.String	topic
protected DialogNodeOutputConnectToAgentTransferInfo	transferInfo
protected java.lang.Boolean	typing

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RuntimeResponseGeneric()

Method Summary

Modifier and Type	Method and Description
java.lang.String	agentAvailable() Gets the agentAvailable.
java.lang.String	agentUnavailable() Gets the agentUnavailable.
java.lang.String	description() Gets the description.
java.lang.String	dialogNode() Gets the dialogNode.
java.lang.String	messageToHumanAgent() Gets the messageToHumanAgent.
java.util.List<DialogNodeOutputOptionsElement>	options() Gets the options.
java.lang.String	preference() Gets the preference.
java.lang.String	responseType() Gets the responseType.
java.lang.String	source() Gets the source.
java.util.List<DialogSuggestion>	suggestions() Gets the suggestions.
java.lang.String	text() Gets the text.
java.lang.Long	time() Gets the time.
java.lang.String	title() Gets the title.
java.lang.String	topic() Gets the topic.
DialogNodeOutputConnectToAgentTransferInfo	transferInfo() Gets the transferInfo.
java.lang.Boolean	typing() Gets the typing.

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

discriminatorPropertyName

protected static java.lang.String discriminatorPropertyName

discriminatorMapping

protected static java.util.Map<java.lang.String,java.lang.Class<?>> discriminatorMapping

responseType

@SerializedName(value="response_type")
protected java.lang.String responseType

text

protected java.lang.String text

time

protected java.lang.Long time

typing

protected java.lang.Boolean typing

source

protected java.lang.String source

title

protected java.lang.String title

description

protected java.lang.String description

preference

protected java.lang.String preference

options

protected java.util.List<DialogNodeOutputOptionsElement> options

messageToHumanAgent

@SerializedName(value="message_to_human_agent")
protected java.lang.String messageToHumanAgent

agentAvailable

@SerializedName(value="agent_available")
protected java.lang.String agentAvailable

agentUnavailable

@SerializedName(value="agent_unavailable")
protected java.lang.String agentUnavailable

transferInfo

@SerializedName(value="transfer_info")
protected DialogNodeOutputConnectToAgentTransferInfo transferInfo

topic

protected java.lang.String topic

dialogNode

@SerializedName(value="dialog_node")
protected java.lang.String dialogNode

suggestions

protected java.util.List<DialogSuggestion> suggestions

Constructor Detail

RuntimeResponseGeneric

protected RuntimeResponseGeneric()

Method Detail

responseType

public java.lang.String responseType()

Gets the responseType.

The type of response returned by the dialog node. The specified response type must be supported by the client application or channel.

Returns:

the responseType

text

public java.lang.String text()

Gets the text.

The text of the response.

Returns:

the text

time

public java.lang.Long time()

Gets the time.

How long to pause, in milliseconds.

Returns:

the time

typing

public java.lang.Boolean typing()

Gets the typing.

Whether to send a "user is typing" event during the pause.

Returns:

the typing

source

public java.lang.String source()

Gets the source.

The URL of the image.

Returns:

the source

title

public java.lang.String title()

Gets the title.

The title or introductory text to show before the response.

Returns:

the title

description

public java.lang.String description()

Gets the description.

The description to show with the the response.

Returns:

the description

preference

public java.lang.String preference()

Gets the preference.

The preferred type of control to display.

Returns:

the preference

options

public java.util.List<DialogNodeOutputOptionsElement> options()

Gets the options.

An array of objects describing the options from which the user can choose.

Returns:

the options

messageToHumanAgent

public java.lang.String messageToHumanAgent()

Gets the messageToHumanAgent.

A message to be sent to the human agent who will be taking over the conversation.

Returns:

the messageToHumanAgent

agentAvailable

public java.lang.String agentAvailable()

Gets the agentAvailable.

An optional message to be displayed to the user to indicate that the conversation will be transferred to the next available agent.

Returns:

the agentAvailable

agentUnavailable

public java.lang.String agentUnavailable()

Gets the agentUnavailable.

An optional message to be displayed to the user to indicate that no online agent is available to take over the conversation.

Returns:

the agentUnavailable

transferInfo

public DialogNodeOutputConnectToAgentTransferInfo transferInfo()

Gets the transferInfo.

Routing or other contextual information to be used by target service desk systems.

Returns:

the transferInfo

topic

public java.lang.String topic()

Gets the topic.

A label identifying the topic of the conversation, derived from the **title** property of the relevant node or the **topic** property of the dialog node response.

Returns:

the topic

dialogNode

public java.lang.String dialogNode()

Gets the dialogNode.

The ID of the dialog node that the **topic** property is taken from. The **topic** property is populated using the value of the dialog node's **title** property.

Returns:

the dialogNode

suggestions

public java.util.List<DialogSuggestion> suggestions()

Gets the suggestions.

An array of objects describing the possible matching dialog nodes from which the user can choose.

Returns:

the suggestions