• Home
• com.google.api.grpc
• proto-google-cloud-dialogflow-v2
• 4.55.0
• source code
• WebhookResponseOrBuilder.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.google.cloud.dialogflow.v2.WebhookResponseOrBuilder Maven / Gradle / Ivy

/*
 * Copyright 2024 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/v2/webhook.proto

// Protobuf Java Version: 3.25.4
package com.google.cloud.dialogflow.v2;

public interface WebhookResponseOrBuilder
    extends
    // @@protoc_insertion_point(interface_extends:google.cloud.dialogflow.v2.WebhookResponse)
    com.google.protobuf.MessageOrBuilder {

  /**
   *
   *
   * 
   * 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.v2.QueryResult.fulfillment_text]
   * sent to the integration or API caller.
   * 
   *
   * string fulfillment_text = 1;
   *
   * @return The fulfillmentText.
   */
  java.lang.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.v2.QueryResult.fulfillment_text]
   * sent to the integration or API caller.
   * 
   *
   * string fulfillment_text = 1;
   *
   * @return The bytes for fulfillmentText.
   */
  com.google.protobuf.ByteString getFulfillmentTextBytes();

  /**
   *
   *
   * 
   * Optional. The rich response messages intended for the end-user.
   * When provided, Dialogflow uses this field to populate
   * [QueryResult.fulfillment_messages][google.cloud.dialogflow.v2.QueryResult.fulfillment_messages]
   * sent to the integration or API caller.
   * 
   *
   * repeated .google.cloud.dialogflow.v2.Intent.Message fulfillment_messages = 2;
   */
  java.util.List 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.v2.QueryResult.fulfillment_messages]
   * sent to the integration or API caller.
   * 
   *
   * repeated .google.cloud.dialogflow.v2.Intent.Message fulfillment_messages = 2;
   */
  com.google.cloud.dialogflow.v2.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.v2.QueryResult.fulfillment_messages]
   * sent to the integration or API caller.
   * 
   *
   * repeated .google.cloud.dialogflow.v2.Intent.Message fulfillment_messages = 2;
   */
  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.v2.QueryResult.fulfillment_messages]
   * sent to the integration or API caller.
   * 
   *
   * repeated .google.cloud.dialogflow.v2.Intent.Message fulfillment_messages = 2;
   */
  java.util.List
      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.v2.QueryResult.fulfillment_messages]
   * sent to the integration or API caller.
   * 
   *
   * repeated .google.cloud.dialogflow.v2.Intent.Message fulfillment_messages = 2;
   */
  com.google.cloud.dialogflow.v2.Intent.MessageOrBuilder getFulfillmentMessagesOrBuilder(int index);

  /**
   *
   *
   * 
   * 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.v2.QueryResult.webhook_source]
   * sent to the integration or API caller.
   * 
   *
   * string source = 3;
   *
   * @return The source.
   */
  java.lang.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.v2.QueryResult.webhook_source]
   * sent to the integration or API caller.
   * 
   *
   * string source = 3;
   *
   * @return The bytes for source.
   */
  com.google.protobuf.ByteString getSourceBytes();

  /**
   *
   *
   * 
   * 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.v2.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;
   *
   * @return Whether the payload field is set.
   */
  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.v2.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;
   *
   * @return The payload.
   */
  com.google.protobuf.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.v2.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;
   */
  com.google.protobuf.StructOrBuilder getPayloadOrBuilder();

  /**
   *
   *
   * 
   * 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.v2.QueryResult.output_contexts]
   * sent to the integration or API caller.
   * 
   *
   * repeated .google.cloud.dialogflow.v2.Context output_contexts = 5;
   */
  java.util.List 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.v2.QueryResult.output_contexts]
   * sent to the integration or API caller.
   * 
   *
   * repeated .google.cloud.dialogflow.v2.Context output_contexts = 5;
   */
  com.google.cloud.dialogflow.v2.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.v2.QueryResult.output_contexts]
   * sent to the integration or API caller.
   * 
   *
   * repeated .google.cloud.dialogflow.v2.Context output_contexts = 5;
   */
  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.v2.QueryResult.output_contexts]
   * sent to the integration or API caller.
   * 
   *
   * repeated .google.cloud.dialogflow.v2.Context output_contexts = 5;
   */
  java.util.List
      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.v2.QueryResult.output_contexts]
   * sent to the integration or API caller.
   * 
   *
   * repeated .google.cloud.dialogflow.v2.Context output_contexts = 5;
   */
  com.google.cloud.dialogflow.v2.ContextOrBuilder getOutputContextsOrBuilder(int index);

  /**
   *
   *
   * 
   * Optional. Invokes the supplied events.
   * When this field is set, Dialogflow ignores the `fulfillment_text`,
   * `fulfillment_messages`, and `payload` fields.
   * 
   *
   * .google.cloud.dialogflow.v2.EventInput followup_event_input = 6;
   *
   * @return Whether the followupEventInput field is set.
   */
  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.v2.EventInput followup_event_input = 6;
   *
   * @return The followupEventInput.
   */
  com.google.cloud.dialogflow.v2.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.v2.EventInput followup_event_input = 6;
   */
  com.google.cloud.dialogflow.v2.EventInputOrBuilder getFollowupEventInputOrBuilder();

  /**
   *
   *
   * 
   * 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.v2.SessionEntityType]
   * management methods.
   * 
   *
   * repeated .google.cloud.dialogflow.v2.SessionEntityType session_entity_types = 10;
   */
  java.util.List 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.v2.SessionEntityType]
   * management methods.
   * 
   *
   * repeated .google.cloud.dialogflow.v2.SessionEntityType session_entity_types = 10;
   */
  com.google.cloud.dialogflow.v2.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.v2.SessionEntityType]
   * management methods.
   * 
   *
   * repeated .google.cloud.dialogflow.v2.SessionEntityType session_entity_types = 10;
   */
  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.v2.SessionEntityType]
   * management methods.
   * 
   *
   * repeated .google.cloud.dialogflow.v2.SessionEntityType session_entity_types = 10;
   */
  java.util.List
      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.v2.SessionEntityType]
   * management methods.
   * 
   *
   * repeated .google.cloud.dialogflow.v2.SessionEntityType session_entity_types = 10;
   */
  com.google.cloud.dialogflow.v2.SessionEntityTypeOrBuilder getSessionEntityTypesOrBuilder(
      int index);
}