com.google.cloud.dialogflow.v2beta1

Interface WebhookResponseOrBuilder

All Superinterfaces:

MessageLiteOrBuilder, MessageOrBuilder

All Known Implementing Classes:

WebhookResponse, WebhookResponse.Builder

public interface WebhookResponseOrBuilder
extends MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	getEndInteraction() Optional.
EventInput	getFollowupEventInput() Optional.
EventInputOrBuilder	getFollowupEventInputOrBuilder() Optional.
Intent.Message	getFulfillmentMessages(int index) Optional.
int	getFulfillmentMessagesCount() Optional.
List<Intent.Message>	getFulfillmentMessagesList() Optional.
Intent.MessageOrBuilder	getFulfillmentMessagesOrBuilder(int index) Optional.
List<? extends Intent.MessageOrBuilder>	getFulfillmentMessagesOrBuilderList() Optional.
String	getFulfillmentText() Optional.
ByteString	getFulfillmentTextBytes() Optional.
boolean	getLiveAgentHandoff() Indicates that a live agent should be brought in to handle the interaction with the user.
Context	getOutputContexts(int index) Optional.
int	getOutputContextsCount() Optional.
List<Context>	getOutputContextsList() Optional.
ContextOrBuilder	getOutputContextsOrBuilder(int index) Optional.
List<? extends ContextOrBuilder>	getOutputContextsOrBuilderList() Optional.
Struct	getPayload() Optional.
StructOrBuilder	getPayloadOrBuilder() Optional.
SessionEntityType	getSessionEntityTypes(int index) Optional.
int	getSessionEntityTypesCount() Optional.
List<SessionEntityType>	getSessionEntityTypesList() Optional.
SessionEntityTypeOrBuilder	getSessionEntityTypesOrBuilder(int index) Optional.
List<? extends SessionEntityTypeOrBuilder>	getSessionEntityTypesOrBuilderList() Optional.
String	getSource() Optional.
ByteString	getSourceBytes() Optional.
boolean	hasFollowupEventInput() Optional.
boolean	hasPayload() Optional.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getFulfillmentText

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][google.cloud.dialogflow.v2beta1.QueryResult.fulfillment_text] sent to the integration or API caller.
 

string fulfillment_text = 1;

Returns:

The fulfillmentText.

getFulfillmentTextBytes

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][google.cloud.dialogflow.v2beta1.QueryResult.fulfillment_text] sent to the integration or API caller.
 

string fulfillment_text = 1;

Returns:

The bytes for fulfillmentText.

getFulfillmentMessagesList

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][google.cloud.dialogflow.v2beta1.QueryResult.fulfillment_messages] sent to the integration or API caller.
 

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

getFulfillmentMessages

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][google.cloud.dialogflow.v2beta1.QueryResult.fulfillment_messages] sent to the integration or API caller.
 

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

getFulfillmentMessagesCount

int getFulfillmentMessagesCount()

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

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

getFulfillmentMessagesOrBuilderList

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][google.cloud.dialogflow.v2beta1.QueryResult.fulfillment_messages] sent to the integration or API caller.
 

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

getFulfillmentMessagesOrBuilder

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][google.cloud.dialogflow.v2beta1.QueryResult.fulfillment_messages] sent to the integration or API caller.
 

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

getSource

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][google.cloud.dialogflow.v2beta1.QueryResult.webhook_source] sent to the integration or API caller.
 

string source = 3;

Returns:

The source.

getSourceBytes

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][google.cloud.dialogflow.v2beta1.QueryResult.webhook_source] sent to the integration or API caller.
 

string source = 3;

Returns:

The bytes for source.

hasPayload

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][google.cloud.dialogflow.v2beta1.QueryResult.webhook_payload] sent to the integration or API caller.
 This field is also used by the
 [Google Assistant
 integration](https://cloud.google.com/dialogflow/docs/integrations/aog)
 for rich response messages.
 See the format definition at [Google Assistant Dialogflow webhook
 format](https://developers.google.com/assistant/actions/build/json/dialogflow-webhook-json)
 

.google.protobuf.Struct payload = 4;

Returns:

Whether the payload field is set.

getPayload

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][google.cloud.dialogflow.v2beta1.QueryResult.webhook_payload] sent to the integration or API caller.
 This field is also used by the
 [Google Assistant
 integration](https://cloud.google.com/dialogflow/docs/integrations/aog)
 for rich response messages.
 See the format definition at [Google Assistant Dialogflow webhook
 format](https://developers.google.com/assistant/actions/build/json/dialogflow-webhook-json)
 

.google.protobuf.Struct payload = 4;

Returns:

The payload.

getPayloadOrBuilder

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][google.cloud.dialogflow.v2beta1.QueryResult.webhook_payload] sent to the integration or API caller.
 This field is also used by the
 [Google Assistant
 integration](https://cloud.google.com/dialogflow/docs/integrations/aog)
 for rich response messages.
 See the format definition at [Google Assistant Dialogflow webhook
 format](https://developers.google.com/assistant/actions/build/json/dialogflow-webhook-json)
 

.google.protobuf.Struct payload = 4;

getOutputContextsList

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][google.cloud.dialogflow.v2beta1.QueryResult.output_contexts] sent to the integration or API caller.
 

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

getOutputContexts

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][google.cloud.dialogflow.v2beta1.QueryResult.output_contexts] sent to the integration or API caller.
 

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

getOutputContextsCount

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][google.cloud.dialogflow.v2beta1.QueryResult.output_contexts] sent to the integration or API caller.
 

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

getOutputContextsOrBuilderList

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][google.cloud.dialogflow.v2beta1.QueryResult.output_contexts] sent to the integration or API caller.
 

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

getOutputContextsOrBuilder

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][google.cloud.dialogflow.v2beta1.QueryResult.output_contexts] sent to the integration or API caller.
 

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

hasFollowupEventInput

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:

Whether the followupEventInput field is set.

getFollowupEventInput

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:

The followupEventInput.

getFollowupEventInputOrBuilder

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;

getLiveAgentHandoff

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:

The liveAgentHandoff.

getEndInteraction

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:

The endInteraction.

getSessionEntityTypesList

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][google.cloud.dialogflow.v2beta1.SessionEntityType] management methods.
 

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

getSessionEntityTypes

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][google.cloud.dialogflow.v2beta1.SessionEntityType] management methods.
 

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

getSessionEntityTypesCount

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][google.cloud.dialogflow.v2beta1.SessionEntityType] management methods.
 

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

getSessionEntityTypesOrBuilderList

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][google.cloud.dialogflow.v2beta1.SessionEntityType] management methods.
 

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

getSessionEntityTypesOrBuilder

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][google.cloud.dialogflow.v2beta1.SessionEntityType] management methods.
 

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