• Home
• com.google.api.grpc
• proto-google-cloud-dialogflow-cx-v3beta1
• 0.65.0
• source code
• FulfillmentOrBuilder.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.cx.v3beta1.FulfillmentOrBuilder 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/cx/v3beta1/fulfillment.proto

// Protobuf Java Version: 3.25.5
package com.google.cloud.dialogflow.cx.v3beta1;

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

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

  /**
   *
   *
   * 
   * The webhook to call.
   * Format:
   * `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/webhooks/<WebhookID>`.
   * 
   *
   * string webhook = 2 [(.google.api.resource_reference) = { ... }
   *
   * @return The webhook.
   */
  java.lang.String getWebhook();
  /**
   *
   *
   * 
   * The webhook to call.
   * Format:
   * `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/webhooks/<WebhookID>`.
   * 
   *
   * 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 value of this field will be populated in the
   * [WebhookRequest][google.cloud.dialogflow.cx.v3beta1.WebhookRequest]
   * `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is
   * called.
   * The tag is typically used by the webhook service to identify which
   * fulfillment is being called, but it could be used for other purposes.
   * This field is required if `webhook` is specified.
   * 
   *
   * string tag = 3;
   *
   * @return The tag.
   */
  java.lang.String getTag();
  /**
   *
   *
   * 
   * The value of this field will be populated in the
   * [WebhookRequest][google.cloud.dialogflow.cx.v3beta1.WebhookRequest]
   * `fulfillmentInfo.tag` field by Dialogflow when the associated webhook is
   * called.
   * The tag is typically used by the webhook service to identify which
   * fulfillment is being called, but it could be used for other purposes.
   * 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.v3beta1.Fulfillment.SetParameterAction set_parameter_actions = 4;
   * 
   */
  java.util.List
      getSetParameterActionsList();
  /**
   *
   *
   * 
   * Set parameter values before executing the webhook.
   * 
   *
   * 
   * repeated .google.cloud.dialogflow.cx.v3beta1.Fulfillment.SetParameterAction set_parameter_actions = 4;
   * 
   */
  com.google.cloud.dialogflow.cx.v3beta1.Fulfillment.SetParameterAction getSetParameterActions(
      int index);
  /**
   *
   *
   * 
   * Set parameter values before executing the webhook.
   * 
   *
   * 
   * repeated .google.cloud.dialogflow.cx.v3beta1.Fulfillment.SetParameterAction set_parameter_actions = 4;
   * 
   */
  int getSetParameterActionsCount();
  /**
   *
   *
   * 
   * Set parameter values before executing the webhook.
   * 
   *
   * 
   * repeated .google.cloud.dialogflow.cx.v3beta1.Fulfillment.SetParameterAction set_parameter_actions = 4;
   * 
   */
  java.util.List<
          ? extends com.google.cloud.dialogflow.cx.v3beta1.Fulfillment.SetParameterActionOrBuilder>
      getSetParameterActionsOrBuilderList();
  /**
   *
   *
   * 
   * Set parameter values before executing the webhook.
   * 
   *
   * 
   * repeated .google.cloud.dialogflow.cx.v3beta1.Fulfillment.SetParameterAction set_parameter_actions = 4;
   * 
   */
  com.google.cloud.dialogflow.cx.v3beta1.Fulfillment.SetParameterActionOrBuilder
      getSetParameterActionsOrBuilder(int index);

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

  /**
   *
   *
   * 
   * Hierarchical advanced settings for this fulfillment. The settings exposed
   * at the lower level overrides the settings exposed at the higher level.
   * 
   *
   * .google.cloud.dialogflow.cx.v3beta1.AdvancedSettings advanced_settings = 7;
   *
   * @return Whether the advancedSettings field is set.
   */
  boolean hasAdvancedSettings();
  /**
   *
   *
   * 
   * Hierarchical advanced settings for this fulfillment. The settings exposed
   * at the lower level overrides the settings exposed at the higher level.
   * 
   *
   * .google.cloud.dialogflow.cx.v3beta1.AdvancedSettings advanced_settings = 7;
   *
   * @return The advancedSettings.
   */
  com.google.cloud.dialogflow.cx.v3beta1.AdvancedSettings getAdvancedSettings();
  /**
   *
   *
   * 
   * Hierarchical advanced settings for this fulfillment. The settings exposed
   * at the lower level overrides the settings exposed at the higher level.
   * 
   *
   * .google.cloud.dialogflow.cx.v3beta1.AdvancedSettings advanced_settings = 7;
   */
  com.google.cloud.dialogflow.cx.v3beta1.AdvancedSettingsOrBuilder getAdvancedSettingsOrBuilder();

  /**
   *
   *
   * 
   * If the flag is true, the agent will utilize LLM to generate a text
   * response. If LLM generation fails, the defined
   * [responses][google.cloud.dialogflow.cx.v3beta1.Fulfillment.messages] in the
   * fulfillment will be respected. This flag is only useful for fulfillments
   * associated with no-match event handlers.
   * 
   *
   * bool enable_generative_fallback = 12;
   *
   * @return The enableGenerativeFallback.
   */
  boolean getEnableGenerativeFallback();
}