Interface WebhookResponseOrBuilder (4.39.0) 

public interface WebhookResponseOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getEndInteraction()

public abstract boolean getEndInteraction()

Optional. Indicates that this intent ends an interaction. Some integrations (e.g., Actions on Google or Dialogflow phone gateway) use this information to close interaction with an end user. Default is false.

bool end_interaction = 8;

Returns
Type Description
boolean

The endInteraction.

getFollowupEventInput()

public abstract EventInput getFollowupEventInput()

Optional. Invokes the supplied events. When this field is set, Dialogflow ignores the fulfillment_text, fulfillment_messages, and payload fields.

.google.cloud.dialogflow.v2beta1.EventInput followup_event_input = 6;

Returns
Type Description
EventInput

The followupEventInput.

getFollowupEventInputOrBuilder()

public abstract EventInputOrBuilder getFollowupEventInputOrBuilder()

Optional. Invokes the supplied events. When this field is set, Dialogflow ignores the fulfillment_text, fulfillment_messages, and payload fields.

.google.cloud.dialogflow.v2beta1.EventInput followup_event_input = 6;

Returns
Type Description
EventInputOrBuilder

getFulfillmentMessages(int index)

public abstract Intent.Message getFulfillmentMessages(int index)

Optional. The rich response messages intended for the end-user. When provided, Dialogflow uses this field to populate QueryResult.fulfillment_messages sent to the integration or API caller.

repeated .google.cloud.dialogflow.v2beta1.Intent.Message fulfillment_messages = 2;

Parameter
Name Description
index int
Returns
Type Description
Intent.Message

getFulfillmentMessagesCount()

public abstract int getFulfillmentMessagesCount()

Optional. The rich response messages intended for the end-user. When provided, Dialogflow uses this field to populate QueryResult.fulfillment_messages sent to the integration or API caller.

repeated .google.cloud.dialogflow.v2beta1.Intent.Message fulfillment_messages = 2;

Returns
Type Description
int

getFulfillmentMessagesList()

public abstract List<Intent.Message> getFulfillmentMessagesList()

Optional. The rich response messages intended for the end-user. When provided, Dialogflow uses this field to populate QueryResult.fulfillment_messages sent to the integration or API caller.

repeated .google.cloud.dialogflow.v2beta1.Intent.Message fulfillment_messages = 2;

Returns
Type Description
List<Message>

getFulfillmentMessagesOrBuilder(int index)

public abstract Intent.MessageOrBuilder getFulfillmentMessagesOrBuilder(int index)

Optional. The rich response messages intended for the end-user. When provided, Dialogflow uses this field to populate QueryResult.fulfillment_messages sent to the integration or API caller.

repeated .google.cloud.dialogflow.v2beta1.Intent.Message fulfillment_messages = 2;

Parameter
Name Description
index int
Returns
Type Description
Intent.MessageOrBuilder

getFulfillmentMessagesOrBuilderList()

public abstract List<? extends Intent.MessageOrBuilder> getFulfillmentMessagesOrBuilderList()

Optional. The rich response messages intended for the end-user. When provided, Dialogflow uses this field to populate QueryResult.fulfillment_messages sent to the integration or API caller.

repeated .google.cloud.dialogflow.v2beta1.Intent.Message fulfillment_messages = 2;

Returns
Type Description
List<? extends com.google.cloud.dialogflow.v2beta1.Intent.MessageOrBuilder>

getFulfillmentText()

public abstract String getFulfillmentText()

Optional. The text response message intended for the end-user. It is recommended to use fulfillment_messages.text.text[0] instead. When provided, Dialogflow uses this field to populate QueryResult.fulfillment_text sent to the integration or API caller.

string fulfillment_text = 1;

Returns
Type Description
String

The fulfillmentText.

getFulfillmentTextBytes()

public abstract ByteString getFulfillmentTextBytes()

Optional. The text response message intended for the end-user. It is recommended to use fulfillment_messages.text.text[0] instead. When provided, Dialogflow uses this field to populate QueryResult.fulfillment_text sent to the integration or API caller.

string fulfillment_text = 1;

Returns
Type Description
ByteString

The bytes for fulfillmentText.

getLiveAgentHandoff()

public abstract boolean getLiveAgentHandoff()

Indicates that a live agent should be brought in to handle the interaction with the user. In most cases, when you set this flag to true, you would also want to set end_interaction to true as well. Default is false.

bool live_agent_handoff = 7;

Returns
Type Description
boolean

The liveAgentHandoff.

getOutputContexts(int index)

public abstract Context getOutputContexts(int index)

Optional. The collection of output contexts that will overwrite currently active contexts for the session and reset their lifespans. When provided, Dialogflow uses this field to populate QueryResult.output_contexts sent to the integration or API caller.

repeated .google.cloud.dialogflow.v2beta1.Context output_contexts = 5;

Parameter
Name Description
index int
Returns
Type Description
Context

getOutputContextsCount()

public abstract int getOutputContextsCount()

Optional. The collection of output contexts that will overwrite currently active contexts for the session and reset their lifespans. When provided, Dialogflow uses this field to populate QueryResult.output_contexts sent to the integration or API caller.

repeated .google.cloud.dialogflow.v2beta1.Context output_contexts = 5;

Returns
Type Description
int

getOutputContextsList()

public abstract List<Context> getOutputContextsList()

Optional. The collection of output contexts that will overwrite currently active contexts for the session and reset their lifespans. When provided, Dialogflow uses this field to populate QueryResult.output_contexts sent to the integration or API caller.

repeated .google.cloud.dialogflow.v2beta1.Context output_contexts = 5;

Returns
Type Description
List<Context>

getOutputContextsOrBuilder(int index)

public abstract ContextOrBuilder getOutputContextsOrBuilder(int index)

Optional. The collection of output contexts that will overwrite currently active contexts for the session and reset their lifespans. When provided, Dialogflow uses this field to populate QueryResult.output_contexts sent to the integration or API caller.

repeated .google.cloud.dialogflow.v2beta1.Context output_contexts = 5;

Parameter
Name Description
index int
Returns
Type Description
ContextOrBuilder

getOutputContextsOrBuilderList()

public abstract List<? extends ContextOrBuilder> getOutputContextsOrBuilderList()

Optional. The collection of output contexts that will overwrite currently active contexts for the session and reset their lifespans. When provided, Dialogflow uses this field to populate QueryResult.output_contexts sent to the integration or API caller.

repeated .google.cloud.dialogflow.v2beta1.Context output_contexts = 5;

Returns
Type Description
List<? extends com.google.cloud.dialogflow.v2beta1.ContextOrBuilder>

getPayload()

public abstract Struct getPayload()

Optional. This field can be used to pass custom data from your webhook to the integration or API caller. Arbitrary JSON objects are supported. When provided, Dialogflow uses this field to populate QueryResult.webhook_payload sent to the integration or API caller. This field is also used by the Google Assistant integration for rich response messages. See the format definition at Google Assistant Dialogflow webhook format

.google.protobuf.Struct payload = 4;

Returns
Type Description
Struct

The payload.

getPayloadOrBuilder()

public abstract StructOrBuilder getPayloadOrBuilder()

Optional. This field can be used to pass custom data from your webhook to the integration or API caller. Arbitrary JSON objects are supported. When provided, Dialogflow uses this field to populate QueryResult.webhook_payload sent to the integration or API caller. This field is also used by the Google Assistant integration for rich response messages. See the format definition at Google Assistant Dialogflow webhook format

.google.protobuf.Struct payload = 4;

Returns
Type Description
StructOrBuilder

getSessionEntityTypes(int index)

public abstract SessionEntityType getSessionEntityTypes(int index)

Optional. Additional session entity types to replace or extend developer entity types with. The entity synonyms apply to all languages and persist for the session. Setting this data from a webhook overwrites the session entity types that have been set using detectIntent, streamingDetectIntent or SessionEntityType management methods.

repeated .google.cloud.dialogflow.v2beta1.SessionEntityType session_entity_types = 10;

Parameter
Name Description
index int
Returns
Type Description
SessionEntityType

getSessionEntityTypesCount()

public abstract int getSessionEntityTypesCount()

Optional. Additional session entity types to replace or extend developer entity types with. The entity synonyms apply to all languages and persist for the session. Setting this data from a webhook overwrites the session entity types that have been set using detectIntent, streamingDetectIntent or SessionEntityType management methods.

repeated .google.cloud.dialogflow.v2beta1.SessionEntityType session_entity_types = 10;

Returns
Type Description
int

getSessionEntityTypesList()

public abstract List<SessionEntityType> getSessionEntityTypesList()

Optional. Additional session entity types to replace or extend developer entity types with. The entity synonyms apply to all languages and persist for the session. Setting this data from a webhook overwrites the session entity types that have been set using detectIntent, streamingDetectIntent or SessionEntityType management methods.

repeated .google.cloud.dialogflow.v2beta1.SessionEntityType session_entity_types = 10;

Returns
Type Description
List<SessionEntityType>

getSessionEntityTypesOrBuilder(int index)

public abstract SessionEntityTypeOrBuilder getSessionEntityTypesOrBuilder(int index)

Optional. Additional session entity types to replace or extend developer entity types with. The entity synonyms apply to all languages and persist for the session. Setting this data from a webhook overwrites the session entity types that have been set using detectIntent, streamingDetectIntent or SessionEntityType management methods.

repeated .google.cloud.dialogflow.v2beta1.SessionEntityType session_entity_types = 10;

Parameter
Name Description
index int
Returns
Type Description
SessionEntityTypeOrBuilder

getSessionEntityTypesOrBuilderList()

public abstract List<? extends SessionEntityTypeOrBuilder> getSessionEntityTypesOrBuilderList()

Optional. Additional session entity types to replace or extend developer entity types with. The entity synonyms apply to all languages and persist for the session. Setting this data from a webhook overwrites the session entity types that have been set using detectIntent, streamingDetectIntent or SessionEntityType management methods.

repeated .google.cloud.dialogflow.v2beta1.SessionEntityType session_entity_types = 10;

Returns
Type Description
List<? extends com.google.cloud.dialogflow.v2beta1.SessionEntityTypeOrBuilder>

getSource()

public abstract String getSource()

Optional. A custom field used to identify the webhook source. Arbitrary strings are supported. When provided, Dialogflow uses this field to populate QueryResult.webhook_source sent to the integration or API caller.

string source = 3;

Returns
Type Description
String

The source.

getSourceBytes()

public abstract ByteString getSourceBytes()

Optional. A custom field used to identify the webhook source. Arbitrary strings are supported. When provided, Dialogflow uses this field to populate QueryResult.webhook_source sent to the integration or API caller.

string source = 3;

Returns
Type Description
ByteString

The bytes for source.

hasFollowupEventInput()

public abstract boolean hasFollowupEventInput()

Optional. Invokes the supplied events. When this field is set, Dialogflow ignores the fulfillment_text, fulfillment_messages, and payload fields.

.google.cloud.dialogflow.v2beta1.EventInput followup_event_input = 6;

Returns
Type Description
boolean

Whether the followupEventInput field is set.

hasPayload()

public abstract boolean hasPayload()

Optional. This field can be used to pass custom data from your webhook to the integration or API caller. Arbitrary JSON objects are supported. When provided, Dialogflow uses this field to populate QueryResult.webhook_payload sent to the integration or API caller. This field is also used by the Google Assistant integration for rich response messages. See the format definition at Google Assistant Dialogflow webhook format

.google.protobuf.Struct payload = 4;

Returns
Type Description
boolean

Whether the payload field is set.