com.google.cloud.dialogflow.cx.v3.FulfillmentOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of proto-google-cloud-dialogflow-cx-v3 Show documentation
PROTO library for proto-google-cloud-dialogflow-cx-v3
There is a newer version: 0.66.0
Show newest version
/*
 * 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/fulfillment.proto

package com.google.cloud.dialogflow.cx.v3;

public interface FulfillmentOrBuilder
    extends
    // @@protoc_insertion_point(interface_extends:google.cloud.dialogflow.cx.v3.Fulfillment)
    com.google.protobuf.MessageOrBuilder {

  /**
   *
   *
   *    * The list of rich message responses to present to the user.
   * 
   *
   * repeated .google.cloud.dialogflow.cx.v3.ResponseMessage messages = 1;
   */
  java.util.List getMessagesList();
  /**
   *
   *
   *    * The list of rich message responses to present to the user.
   * 
   *
   * repeated .google.cloud.dialogflow.cx.v3.ResponseMessage messages = 1;
   */
  com.google.cloud.dialogflow.cx.v3.ResponseMessage getMessages(int index);
  /**
   *
   *
   *    * The list of rich message responses to present to the user.
   * 
   *
   * repeated .google.cloud.dialogflow.cx.v3.ResponseMessage messages = 1;
   */
  int getMessagesCount();
  /**
   *
   *
   *    * The list of rich message responses to present to the user.
   * 
   *
   * repeated .google.cloud.dialogflow.cx.v3.ResponseMessage messages = 1;
   */
  java.util.List
      getMessagesOrBuilderList();
  /**
   *
   *
   *    * The list of rich message responses to present to the user.
   * 
   *
   * repeated .google.cloud.dialogflow.cx.v3.ResponseMessage messages = 1;
   */
  com.google.cloud.dialogflow.cx.v3.ResponseMessageOrBuilder getMessagesOrBuilder(int index);

  /**
   *
   *
   *    * The webhook to call.
   * Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
   * ID>/webhooks/<Webhook ID>`.
   * 
   *
   * string webhook = 2 [(.google.api.resource_reference) = { ... }
   *
   * @return The webhook.
   */
  java.lang.String getWebhook();
  /**
   *
   *
   *    * The webhook to call.
   * Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
   * ID>/webhooks/<Webhook ID>`.
   * 
   *
   * string webhook = 2 [(.google.api.resource_reference) = { ... }
   *
   * @return The bytes for webhook.
   */
  com.google.protobuf.ByteString getWebhookBytes();

  /**
   *
   *
   *    * Whether Dialogflow should return currently queued fulfillment response
   * messages in streaming APIs. If a webhook is specified, it happens before
   * Dialogflow invokes webhook.
   * Warning:
   * 1) This flag only affects streaming API. Responses are still queued
   * and returned once in non-streaming API.
   * 2) The flag can be enabled in any fulfillment but only the first 3 partial
   * responses will be returned. You may only want to apply it to fulfillments
   * that have slow webhooks.
   * 
   *
   * bool return_partial_responses = 8;
   *
   * @return The returnPartialResponses.
   */
  boolean getReturnPartialResponses();

  /**
   *
   *
   *    * The tag used by the webhook to identify which fulfillment is being called.
   * This field is required if `webhook` is specified.
   * 
   *
   * string tag = 3;
   *
   * @return The tag.
   */
  java.lang.String getTag();
  /**
   *
   *
   *    * The tag used by the webhook to identify which fulfillment is being called.
   * This field is required if `webhook` is specified.
   * 
   *
   * string tag = 3;
   *
   * @return The bytes for tag.
   */
  com.google.protobuf.ByteString getTagBytes();

  /**
   *
   *
   *    * Set parameter values before executing the webhook.
   * 
   *
   * 
   * repeated .google.cloud.dialogflow.cx.v3.Fulfillment.SetParameterAction set_parameter_actions = 4;
   * 
   */
  java.util.List
      getSetParameterActionsList();
  /**
   *
   *
   *    * Set parameter values before executing the webhook.
   * 
   *
   * 
   * repeated .google.cloud.dialogflow.cx.v3.Fulfillment.SetParameterAction set_parameter_actions = 4;
   * 
   */
  com.google.cloud.dialogflow.cx.v3.Fulfillment.SetParameterAction getSetParameterActions(
      int index);
  /**
   *
   *
   *    * Set parameter values before executing the webhook.
   * 
   *
   * 
   * repeated .google.cloud.dialogflow.cx.v3.Fulfillment.SetParameterAction set_parameter_actions = 4;
   * 
   */
  int getSetParameterActionsCount();
  /**
   *
   *
   *    * Set parameter values before executing the webhook.
   * 
   *
   * 
   * repeated .google.cloud.dialogflow.cx.v3.Fulfillment.SetParameterAction set_parameter_actions = 4;
   * 
   */
  java.util.List<
          ? extends com.google.cloud.dialogflow.cx.v3.Fulfillment.SetParameterActionOrBuilder>
      getSetParameterActionsOrBuilderList();
  /**
   *
   *
   *    * Set parameter values before executing the webhook.
   * 
   *
   * 
   * repeated .google.cloud.dialogflow.cx.v3.Fulfillment.SetParameterAction set_parameter_actions = 4;
   * 
   */
  com.google.cloud.dialogflow.cx.v3.Fulfillment.SetParameterActionOrBuilder
      getSetParameterActionsOrBuilder(int index);

  /**
   *
   *
   *    * Conditional cases for this fulfillment.
   * 
   *
   * 
   * repeated .google.cloud.dialogflow.cx.v3.Fulfillment.ConditionalCases conditional_cases = 5;
   * 
   */
  java.util.List
      getConditionalCasesList();
  /**
   *
   *
   *    * Conditional cases for this fulfillment.
   * 
   *
   * 
   * repeated .google.cloud.dialogflow.cx.v3.Fulfillment.ConditionalCases conditional_cases = 5;
   * 
   */
  com.google.cloud.dialogflow.cx.v3.Fulfillment.ConditionalCases getConditionalCases(int index);
  /**
   *
   *
   *    * Conditional cases for this fulfillment.
   * 
   *
   * 
   * repeated .google.cloud.dialogflow.cx.v3.Fulfillment.ConditionalCases conditional_cases = 5;
   * 
   */
  int getConditionalCasesCount();
  /**
   *
   *
   *    * Conditional cases for this fulfillment.
   * 
   *
   * 
   * repeated .google.cloud.dialogflow.cx.v3.Fulfillment.ConditionalCases conditional_cases = 5;
   * 
   */
  java.util.List
      getConditionalCasesOrBuilderList();
  /**
   *
   *
   *    * Conditional cases for this fulfillment.
   * 
   *
   * 
   * repeated .google.cloud.dialogflow.cx.v3.Fulfillment.ConditionalCases conditional_cases = 5;
   * 
   */
  com.google.cloud.dialogflow.cx.v3.Fulfillment.ConditionalCasesOrBuilder
      getConditionalCasesOrBuilder(int index);
}