/*
* Copyright 2020 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/cloud/dialogflow/cx/v3/webhook.proto
package com.google.cloud.dialogflow.cx.v3;
public interface WebhookRequestOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.dialogflow.cx.v3.WebhookRequest)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* Always present. The unique identifier of the
* [DetectIntentResponse][google.cloud.dialogflow.cx.v3.DetectIntentResponse]
* that will be returned to the API caller.
*
*
* string detect_intent_response_id = 1;
*
* @return The detectIntentResponseId.
*/
java.lang.String getDetectIntentResponseId();
/**
*
*
*
* Always present. The unique identifier of the
* [DetectIntentResponse][google.cloud.dialogflow.cx.v3.DetectIntentResponse]
* that will be returned to the API caller.
*
*
* string detect_intent_response_id = 1;
*
* @return The bytes for detectIntentResponseId.
*/
com.google.protobuf.ByteString getDetectIntentResponseIdBytes();
/**
*
*
*
* If [natural language text][google.cloud.dialogflow.cx.v3.TextInput] was
* provided as input, this field will contain a copy of the text.
*
*
* string text = 10;
*
* @return Whether the text field is set.
*/
boolean hasText();
/**
*
*
*
* If [natural language text][google.cloud.dialogflow.cx.v3.TextInput] was
* provided as input, this field will contain a copy of the text.
*
*
* string text = 10;
*
* @return The text.
*/
java.lang.String getText();
/**
*
*
*
* If [natural language text][google.cloud.dialogflow.cx.v3.TextInput] was
* provided as input, this field will contain a copy of the text.
*
*
* string text = 10;
*
* @return The bytes for text.
*/
com.google.protobuf.ByteString getTextBytes();
/**
*
*
*
* If an [intent][google.cloud.dialogflow.cx.v3.IntentInput] was provided as
* input, this field will contain a copy of the intent identifier. Format:
* `projects/<Project ID>/locations/<Location ID>/agents/<Agent
* ID>/intents/<Intent ID>`.
*
*
* string trigger_intent = 11 [(.google.api.resource_reference) = { ... }
*
* @return Whether the triggerIntent field is set.
*/
boolean hasTriggerIntent();
/**
*
*
*
* If an [intent][google.cloud.dialogflow.cx.v3.IntentInput] was provided as
* input, this field will contain a copy of the intent identifier. Format:
* `projects/<Project ID>/locations/<Location ID>/agents/<Agent
* ID>/intents/<Intent ID>`.
*
*
* string trigger_intent = 11 [(.google.api.resource_reference) = { ... }
*
* @return The triggerIntent.
*/
java.lang.String getTriggerIntent();
/**
*
*
*
* If an [intent][google.cloud.dialogflow.cx.v3.IntentInput] was provided as
* input, this field will contain a copy of the intent identifier. Format:
* `projects/<Project ID>/locations/<Location ID>/agents/<Agent
* ID>/intents/<Intent ID>`.
*
*
* string trigger_intent = 11 [(.google.api.resource_reference) = { ... }
*
* @return The bytes for triggerIntent.
*/
com.google.protobuf.ByteString getTriggerIntentBytes();
/**
*
*
*
* If [natural language speech
* audio][google.cloud.dialogflow.cx.v3.AudioInput] was provided as input,
* this field will contain the transcript for the audio.
*
*
* string transcript = 12;
*
* @return Whether the transcript field is set.
*/
boolean hasTranscript();
/**
*
*
*
* If [natural language speech
* audio][google.cloud.dialogflow.cx.v3.AudioInput] was provided as input,
* this field will contain the transcript for the audio.
*
*
* string transcript = 12;
*
* @return The transcript.
*/
java.lang.String getTranscript();
/**
*
*
*
* If [natural language speech
* audio][google.cloud.dialogflow.cx.v3.AudioInput] was provided as input,
* this field will contain the transcript for the audio.
*
*
* string transcript = 12;
*
* @return The bytes for transcript.
*/
com.google.protobuf.ByteString getTranscriptBytes();
/**
*
*
*
* If an [event][google.cloud.dialogflow.cx.v3.EventInput] was provided as
* input, this field will contain the name of the event.
*
*
* string trigger_event = 14;
*
* @return Whether the triggerEvent field is set.
*/
boolean hasTriggerEvent();
/**
*
*
*
* If an [event][google.cloud.dialogflow.cx.v3.EventInput] was provided as
* input, this field will contain the name of the event.
*
*
* string trigger_event = 14;
*
* @return The triggerEvent.
*/
java.lang.String getTriggerEvent();
/**
*
*
*
* If an [event][google.cloud.dialogflow.cx.v3.EventInput] was provided as
* input, this field will contain the name of the event.
*
*
* string trigger_event = 14;
*
* @return The bytes for triggerEvent.
*/
com.google.protobuf.ByteString getTriggerEventBytes();
/**
*
*
*
* If [DTMF][google.cloud.dialogflow.cx.v3.DtmfInput] was provided as input,
* this field will contain the DTMF digits.
*
*
* string dtmf_digits = 17;
*
* @return Whether the dtmfDigits field is set.
*/
boolean hasDtmfDigits();
/**
*
*
*
* If [DTMF][google.cloud.dialogflow.cx.v3.DtmfInput] was provided as input,
* this field will contain the DTMF digits.
*
*
* string dtmf_digits = 17;
*
* @return The dtmfDigits.
*/
java.lang.String getDtmfDigits();
/**
*
*
*
* If [DTMF][google.cloud.dialogflow.cx.v3.DtmfInput] was provided as input,
* this field will contain the DTMF digits.
*
*
* string dtmf_digits = 17;
*
* @return The bytes for dtmfDigits.
*/
com.google.protobuf.ByteString getDtmfDigitsBytes();
/**
*
*
*
* The language code specified in the [original
* request][QueryInput.language_code].
*
*
* string language_code = 15;
*
* @return The languageCode.
*/
java.lang.String getLanguageCode();
/**
*
*
*
* The language code specified in the [original
* request][QueryInput.language_code].
*
*
* string language_code = 15;
*
* @return The bytes for languageCode.
*/
com.google.protobuf.ByteString getLanguageCodeBytes();
/**
*
*
*
* Always present. Information about the fulfillment that triggered this
* webhook call.
*
*
* .google.cloud.dialogflow.cx.v3.WebhookRequest.FulfillmentInfo fulfillment_info = 6;
*
*
* @return Whether the fulfillmentInfo field is set.
*/
boolean hasFulfillmentInfo();
/**
*
*
*
* Always present. Information about the fulfillment that triggered this
* webhook call.
*
*
* .google.cloud.dialogflow.cx.v3.WebhookRequest.FulfillmentInfo fulfillment_info = 6;
*
*
* @return The fulfillmentInfo.
*/
com.google.cloud.dialogflow.cx.v3.WebhookRequest.FulfillmentInfo getFulfillmentInfo();
/**
*
*
*
* Always present. Information about the fulfillment that triggered this
* webhook call.
*
*
* .google.cloud.dialogflow.cx.v3.WebhookRequest.FulfillmentInfo fulfillment_info = 6;
*
*/
com.google.cloud.dialogflow.cx.v3.WebhookRequest.FulfillmentInfoOrBuilder
getFulfillmentInfoOrBuilder();
/**
*
*
*
* Information about the last matched intent.
*
*
* .google.cloud.dialogflow.cx.v3.WebhookRequest.IntentInfo intent_info = 3;
*
* @return Whether the intentInfo field is set.
*/
boolean hasIntentInfo();
/**
*
*
*
* Information about the last matched intent.
*
*
* .google.cloud.dialogflow.cx.v3.WebhookRequest.IntentInfo intent_info = 3;
*
* @return The intentInfo.
*/
com.google.cloud.dialogflow.cx.v3.WebhookRequest.IntentInfo getIntentInfo();
/**
*
*
*
* Information about the last matched intent.
*
*
* .google.cloud.dialogflow.cx.v3.WebhookRequest.IntentInfo intent_info = 3;
*/
com.google.cloud.dialogflow.cx.v3.WebhookRequest.IntentInfoOrBuilder getIntentInfoOrBuilder();
/**
*
*
*
* Information about page status.
*
*
* .google.cloud.dialogflow.cx.v3.PageInfo page_info = 4;
*
* @return Whether the pageInfo field is set.
*/
boolean hasPageInfo();
/**
*
*
*
* Information about page status.
*
*
* .google.cloud.dialogflow.cx.v3.PageInfo page_info = 4;
*
* @return The pageInfo.
*/
com.google.cloud.dialogflow.cx.v3.PageInfo getPageInfo();
/**
*
*
*
* Information about page status.
*
*
* .google.cloud.dialogflow.cx.v3.PageInfo page_info = 4;
*/
com.google.cloud.dialogflow.cx.v3.PageInfoOrBuilder getPageInfoOrBuilder();
/**
*
*
*
* Information about session status.
*
*
* .google.cloud.dialogflow.cx.v3.SessionInfo session_info = 5;
*
* @return Whether the sessionInfo field is set.
*/
boolean hasSessionInfo();
/**
*
*
*
* Information about session status.
*
*
* .google.cloud.dialogflow.cx.v3.SessionInfo session_info = 5;
*
* @return The sessionInfo.
*/
com.google.cloud.dialogflow.cx.v3.SessionInfo getSessionInfo();
/**
*
*
*
* Information about session status.
*
*
* .google.cloud.dialogflow.cx.v3.SessionInfo session_info = 5;
*/
com.google.cloud.dialogflow.cx.v3.SessionInfoOrBuilder getSessionInfoOrBuilder();
/**
*
*
*
* The list of rich message responses to present to the user. Webhook can
* choose to append or replace this list in
* [WebhookResponse.fulfillment_response][google.cloud.dialogflow.cx.v3.WebhookResponse.fulfillment_response];
*
*
* repeated .google.cloud.dialogflow.cx.v3.ResponseMessage messages = 7;
*/
java.util.List getMessagesList();
/**
*
*
*
* The list of rich message responses to present to the user. Webhook can
* choose to append or replace this list in
* [WebhookResponse.fulfillment_response][google.cloud.dialogflow.cx.v3.WebhookResponse.fulfillment_response];
*
*
* repeated .google.cloud.dialogflow.cx.v3.ResponseMessage messages = 7;
*/
com.google.cloud.dialogflow.cx.v3.ResponseMessage getMessages(int index);
/**
*
*
*
* The list of rich message responses to present to the user. Webhook can
* choose to append or replace this list in
* [WebhookResponse.fulfillment_response][google.cloud.dialogflow.cx.v3.WebhookResponse.fulfillment_response];
*
*
* repeated .google.cloud.dialogflow.cx.v3.ResponseMessage messages = 7;
*/
int getMessagesCount();
/**
*
*
*
* The list of rich message responses to present to the user. Webhook can
* choose to append or replace this list in
* [WebhookResponse.fulfillment_response][google.cloud.dialogflow.cx.v3.WebhookResponse.fulfillment_response];
*
*
* repeated .google.cloud.dialogflow.cx.v3.ResponseMessage messages = 7;
*/
java.util.List
getMessagesOrBuilderList();
/**
*
*
*
* The list of rich message responses to present to the user. Webhook can
* choose to append or replace this list in
* [WebhookResponse.fulfillment_response][google.cloud.dialogflow.cx.v3.WebhookResponse.fulfillment_response];
*
*
* repeated .google.cloud.dialogflow.cx.v3.ResponseMessage messages = 7;
*/
com.google.cloud.dialogflow.cx.v3.ResponseMessageOrBuilder getMessagesOrBuilder(int index);
/**
*
*
*
* Custom data set in
* [QueryParameters.payload][google.cloud.dialogflow.cx.v3.QueryParameters.payload].
*
*
* .google.protobuf.Struct payload = 8;
*
* @return Whether the payload field is set.
*/
boolean hasPayload();
/**
*
*
*
* Custom data set in
* [QueryParameters.payload][google.cloud.dialogflow.cx.v3.QueryParameters.payload].
*
*
* .google.protobuf.Struct payload = 8;
*
* @return The payload.
*/
com.google.protobuf.Struct getPayload();
/**
*
*
*
* Custom data set in
* [QueryParameters.payload][google.cloud.dialogflow.cx.v3.QueryParameters.payload].
*
*
* .google.protobuf.Struct payload = 8;
*/
com.google.protobuf.StructOrBuilder getPayloadOrBuilder();
/**
*
*
*
* The sentiment analysis result of the current user request. The field is
* filled when sentiment analysis is configured to be enabled for the request.
*
*
*
* .google.cloud.dialogflow.cx.v3.WebhookRequest.SentimentAnalysisResult sentiment_analysis_result = 9;
*
*
* @return Whether the sentimentAnalysisResult field is set.
*/
boolean hasSentimentAnalysisResult();
/**
*
*
*
* The sentiment analysis result of the current user request. The field is
* filled when sentiment analysis is configured to be enabled for the request.
*
*
*
* .google.cloud.dialogflow.cx.v3.WebhookRequest.SentimentAnalysisResult sentiment_analysis_result = 9;
*
*
* @return The sentimentAnalysisResult.
*/
com.google.cloud.dialogflow.cx.v3.WebhookRequest.SentimentAnalysisResult
getSentimentAnalysisResult();
/**
*
*
*
* The sentiment analysis result of the current user request. The field is
* filled when sentiment analysis is configured to be enabled for the request.
*
*
*
* .google.cloud.dialogflow.cx.v3.WebhookRequest.SentimentAnalysisResult sentiment_analysis_result = 9;
*
*/
com.google.cloud.dialogflow.cx.v3.WebhookRequest.SentimentAnalysisResultOrBuilder
getSentimentAnalysisResultOrBuilder();
public com.google.cloud.dialogflow.cx.v3.WebhookRequest.QueryCase getQueryCase();
}