Package com.google.cloud.dialogflow.cx.v3beta1

Interface WebhookRequestOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    WebhookRequest, WebhookRequest.Builder
    public interface WebhookRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getDetectIntentResponseId

        String getDetectIntentResponseId()
         Always present. The unique identifier of the
 [DetectIntentResponse][google.cloud.dialogflow.cx.v3beta1.DetectIntentResponse]
 that will be returned to the API caller.
        string detect_intent_response_id = 1;
        Returns:
        The detectIntentResponseId.

      • getDetectIntentResponseIdBytes

        com.google.protobuf.ByteString getDetectIntentResponseIdBytes()
         Always present. The unique identifier of the
 [DetectIntentResponse][google.cloud.dialogflow.cx.v3beta1.DetectIntentResponse]
 that will be returned to the API caller.
        string detect_intent_response_id = 1;
        Returns:
        The bytes for detectIntentResponseId.

      • hasText

        boolean hasText()
         If [natural language text][google.cloud.dialogflow.cx.v3beta1.TextInput]
 was provided as input, this field will contain a copy of the text.
        string text = 10;
        Returns:
        Whether the text field is set.

      • getText

        String getText()
         If [natural language text][google.cloud.dialogflow.cx.v3beta1.TextInput]
 was provided as input, this field will contain a copy of the text.
        string text = 10;
        Returns:
        The text.

      • getTextBytes

        com.google.protobuf.ByteString getTextBytes()
         If [natural language text][google.cloud.dialogflow.cx.v3beta1.TextInput]
 was provided as input, this field will contain a copy of the text.
        string text = 10;
        Returns:
        The bytes for text.

      • hasTriggerIntent

        boolean hasTriggerIntent()
         If an [intent][google.cloud.dialogflow.cx.v3beta1.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) = { ... }
        Returns:
        Whether the triggerIntent field is set.

      • getTriggerIntent

        String getTriggerIntent()
         If an [intent][google.cloud.dialogflow.cx.v3beta1.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) = { ... }
        Returns:
        The triggerIntent.

      • getTriggerIntentBytes

        com.google.protobuf.ByteString getTriggerIntentBytes()
         If an [intent][google.cloud.dialogflow.cx.v3beta1.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) = { ... }
        Returns:
        The bytes for triggerIntent.

      • hasTranscript

        boolean hasTranscript()
         If [natural language speech
 audio][google.cloud.dialogflow.cx.v3beta1.AudioInput] was provided as
 input, this field will contain the transcript for the audio.
        string transcript = 12;
        Returns:
        Whether the transcript field is set.

      • getTranscript

        String getTranscript()
         If [natural language speech
 audio][google.cloud.dialogflow.cx.v3beta1.AudioInput] was provided as
 input, this field will contain the transcript for the audio.
        string transcript = 12;
        Returns:
        The transcript.

      • getTranscriptBytes

        com.google.protobuf.ByteString getTranscriptBytes()
         If [natural language speech
 audio][google.cloud.dialogflow.cx.v3beta1.AudioInput] was provided as
 input, this field will contain the transcript for the audio.
        string transcript = 12;
        Returns:
        The bytes for transcript.

      • hasTriggerEvent

        boolean hasTriggerEvent()
         If an [event][google.cloud.dialogflow.cx.v3beta1.EventInput] was provided
 as input, this field will contain the name of the event.
        string trigger_event = 14;
        Returns:
        Whether the triggerEvent field is set.

      • getTriggerEvent

        String getTriggerEvent()
         If an [event][google.cloud.dialogflow.cx.v3beta1.EventInput] was provided
 as input, this field will contain the name of the event.
        string trigger_event = 14;
        Returns:
        The triggerEvent.

      • getTriggerEventBytes

        com.google.protobuf.ByteString getTriggerEventBytes()
         If an [event][google.cloud.dialogflow.cx.v3beta1.EventInput] was provided
 as input, this field will contain the name of the event.
        string trigger_event = 14;
        Returns:
        The bytes for triggerEvent.

      • hasDtmfDigits

        boolean hasDtmfDigits()
         If [DTMF][google.cloud.dialogflow.cx.v3beta1.DtmfInput] was provided as
 input, this field will contain the DTMF digits.
        string dtmf_digits = 17;
        Returns:
        Whether the dtmfDigits field is set.

      • getDtmfDigits

        String getDtmfDigits()
         If [DTMF][google.cloud.dialogflow.cx.v3beta1.DtmfInput] was provided as
 input, this field will contain the DTMF digits.
        string dtmf_digits = 17;
        Returns:
        The dtmfDigits.

      • getDtmfDigitsBytes

        com.google.protobuf.ByteString getDtmfDigitsBytes()
         If [DTMF][google.cloud.dialogflow.cx.v3beta1.DtmfInput] was provided as
 input, this field will contain the DTMF digits.
        string dtmf_digits = 17;
        Returns:
        The bytes for dtmfDigits.

      • getLanguageCode

        String getLanguageCode()
         The language code specified in the [original
 request][QueryInput.language_code].
        string language_code = 15;
        Returns:
        The languageCode.

      • getLanguageCodeBytes

        com.google.protobuf.ByteString getLanguageCodeBytes()
         The language code specified in the [original
 request][QueryInput.language_code].
        string language_code = 15;
        Returns:
        The bytes for languageCode.

      • hasFulfillmentInfo

        boolean hasFulfillmentInfo()
         Always present. Information about the fulfillment that triggered this
 webhook call.
        .google.cloud.dialogflow.cx.v3beta1.WebhookRequest.FulfillmentInfo fulfillment_info = 6;
        Returns:
        Whether the fulfillmentInfo field is set.

      • getFulfillmentInfo

        WebhookRequest.FulfillmentInfo getFulfillmentInfo()
         Always present. Information about the fulfillment that triggered this
 webhook call.
        .google.cloud.dialogflow.cx.v3beta1.WebhookRequest.FulfillmentInfo fulfillment_info = 6;
        Returns:
        The fulfillmentInfo.

      • getFulfillmentInfoOrBuilder

        WebhookRequest.FulfillmentInfoOrBuilder getFulfillmentInfoOrBuilder()
         Always present. Information about the fulfillment that triggered this
 webhook call.
        .google.cloud.dialogflow.cx.v3beta1.WebhookRequest.FulfillmentInfo fulfillment_info = 6;

      • hasIntentInfo

        boolean hasIntentInfo()
         Information about the last matched intent.
        .google.cloud.dialogflow.cx.v3beta1.WebhookRequest.IntentInfo intent_info = 3;
        Returns:
        Whether the intentInfo field is set.

      • getIntentInfo

        WebhookRequest.IntentInfo getIntentInfo()
         Information about the last matched intent.
        .google.cloud.dialogflow.cx.v3beta1.WebhookRequest.IntentInfo intent_info = 3;
        Returns:
        The intentInfo.

      • getIntentInfoOrBuilder

        WebhookRequest.IntentInfoOrBuilder getIntentInfoOrBuilder()
         Information about the last matched intent.
        .google.cloud.dialogflow.cx.v3beta1.WebhookRequest.IntentInfo intent_info = 3;

      • hasPageInfo

        boolean hasPageInfo()
         Information about page status.
        .google.cloud.dialogflow.cx.v3beta1.PageInfo page_info = 4;
        Returns:
        Whether the pageInfo field is set.

      • getPageInfo

        PageInfo getPageInfo()
         Information about page status.
        .google.cloud.dialogflow.cx.v3beta1.PageInfo page_info = 4;
        Returns:
        The pageInfo.

      • getPageInfoOrBuilder

        PageInfoOrBuilder getPageInfoOrBuilder()
         Information about page status.
        .google.cloud.dialogflow.cx.v3beta1.PageInfo page_info = 4;

      • hasSessionInfo

        boolean hasSessionInfo()
         Information about session status.
        .google.cloud.dialogflow.cx.v3beta1.SessionInfo session_info = 5;
        Returns:
        Whether the sessionInfo field is set.

      • getSessionInfo

        SessionInfo getSessionInfo()
         Information about session status.
        .google.cloud.dialogflow.cx.v3beta1.SessionInfo session_info = 5;
        Returns:
        The sessionInfo.

      • getSessionInfoOrBuilder

        SessionInfoOrBuilder getSessionInfoOrBuilder()
         Information about session status.
        .google.cloud.dialogflow.cx.v3beta1.SessionInfo session_info = 5;

      • getMessagesList

        List<ResponseMessage> 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.v3beta1.WebhookResponse.fulfillment_response];
        repeated .google.cloud.dialogflow.cx.v3beta1.ResponseMessage messages = 7;

      • getMessages

        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.v3beta1.WebhookResponse.fulfillment_response];
        repeated .google.cloud.dialogflow.cx.v3beta1.ResponseMessage messages = 7;

      • getMessagesCount

        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.v3beta1.WebhookResponse.fulfillment_response];
        repeated .google.cloud.dialogflow.cx.v3beta1.ResponseMessage messages = 7;

      • getMessagesOrBuilderList

        List<? extends ResponseMessageOrBuilder> 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.v3beta1.WebhookResponse.fulfillment_response];
        repeated .google.cloud.dialogflow.cx.v3beta1.ResponseMessage messages = 7;

      • getMessagesOrBuilder

        ResponseMessageOrBuilder getMessagesOrBuilder​(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.v3beta1.WebhookResponse.fulfillment_response];
        repeated .google.cloud.dialogflow.cx.v3beta1.ResponseMessage messages = 7;

      • hasPayload

        boolean hasPayload()
         Custom data set in
 [QueryParameters.payload][google.cloud.dialogflow.cx.v3beta1.QueryParameters.payload].
        .google.protobuf.Struct payload = 8;
        Returns:
        Whether the payload field is set.

      • getPayload

        com.google.protobuf.Struct getPayload()
         Custom data set in
 [QueryParameters.payload][google.cloud.dialogflow.cx.v3beta1.QueryParameters.payload].
        .google.protobuf.Struct payload = 8;
        Returns:
        The payload.

      • getPayloadOrBuilder

        com.google.protobuf.StructOrBuilder getPayloadOrBuilder()
         Custom data set in
 [QueryParameters.payload][google.cloud.dialogflow.cx.v3beta1.QueryParameters.payload].
        .google.protobuf.Struct payload = 8;

      • hasSentimentAnalysisResult

        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.v3beta1.WebhookRequest.SentimentAnalysisResult sentiment_analysis_result = 9;
        Returns:
        Whether the sentimentAnalysisResult field is set.

      • getSentimentAnalysisResult

        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.v3beta1.WebhookRequest.SentimentAnalysisResult sentiment_analysis_result = 9;
        Returns:
        The sentimentAnalysisResult.

      • getSentimentAnalysisResultOrBuilder

        WebhookRequest.SentimentAnalysisResultOrBuilder getSentimentAnalysisResultOrBuilder()
         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.v3beta1.WebhookRequest.SentimentAnalysisResult sentiment_analysis_result = 9;