com.google.cloud.dialogflow.cx.v3beta1.EventHandlerOrBuilder 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-v3beta1 Show documentation
PROTO library for proto-google-cloud-dialogflow-cx-v3beta1
The newest version!
/*
 * 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/page.proto

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

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

  /**
   *
   *
   *    * Output only. The unique identifier of this event handler.
   * 
   *
   * string name = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
   *
   * @return The name.
   */
  java.lang.String getName();
  /**
   *
   *
   *    * Output only. The unique identifier of this event handler.
   * 
   *
   * string name = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
   *
   * @return The bytes for name.
   */
  com.google.protobuf.ByteString getNameBytes();

  /**
   *
   *
   *    * Required. The name of the event to handle.
   * 
   *
   * string event = 4 [(.google.api.field_behavior) = REQUIRED];
   *
   * @return The event.
   */
  java.lang.String getEvent();
  /**
   *
   *
   *    * Required. The name of the event to handle.
   * 
   *
   * string event = 4 [(.google.api.field_behavior) = REQUIRED];
   *
   * @return The bytes for event.
   */
  com.google.protobuf.ByteString getEventBytes();

  /**
   *
   *
   *    * The fulfillment to call when the event occurs.
   * Handling webhook errors with a fulfillment enabled with webhook could
   * cause infinite loop. It is invalid to specify such fulfillment for a
   * handler handling webhooks.
   * 
   *
   * .google.cloud.dialogflow.cx.v3beta1.Fulfillment trigger_fulfillment = 5;
   *
   * @return Whether the triggerFulfillment field is set.
   */
  boolean hasTriggerFulfillment();
  /**
   *
   *
   *    * The fulfillment to call when the event occurs.
   * Handling webhook errors with a fulfillment enabled with webhook could
   * cause infinite loop. It is invalid to specify such fulfillment for a
   * handler handling webhooks.
   * 
   *
   * .google.cloud.dialogflow.cx.v3beta1.Fulfillment trigger_fulfillment = 5;
   *
   * @return The triggerFulfillment.
   */
  com.google.cloud.dialogflow.cx.v3beta1.Fulfillment getTriggerFulfillment();
  /**
   *
   *
   *    * The fulfillment to call when the event occurs.
   * Handling webhook errors with a fulfillment enabled with webhook could
   * cause infinite loop. It is invalid to specify such fulfillment for a
   * handler handling webhooks.
   * 
   *
   * .google.cloud.dialogflow.cx.v3beta1.Fulfillment trigger_fulfillment = 5;
   */
  com.google.cloud.dialogflow.cx.v3beta1.FulfillmentOrBuilder getTriggerFulfillmentOrBuilder();

  /**
   *
   *
   *    * The target page to transition to.
   * Format:
   * `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/pages/<PageID>`.
   * 
   *
   * string target_page = 2 [(.google.api.resource_reference) = { ... }
   *
   * @return Whether the targetPage field is set.
   */
  boolean hasTargetPage();
  /**
   *
   *
   *    * The target page to transition to.
   * Format:
   * `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/pages/<PageID>`.
   * 
   *
   * string target_page = 2 [(.google.api.resource_reference) = { ... }
   *
   * @return The targetPage.
   */
  java.lang.String getTargetPage();
  /**
   *
   *
   *    * The target page to transition to.
   * Format:
   * `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/pages/<PageID>`.
   * 
   *
   * string target_page = 2 [(.google.api.resource_reference) = { ... }
   *
   * @return The bytes for targetPage.
   */
  com.google.protobuf.ByteString getTargetPageBytes();

  /**
   *
   *
   *    * The target flow to transition to.
   * Format:
   * `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>`.
   * 
   *
   * string target_flow = 3 [(.google.api.resource_reference) = { ... }
   *
   * @return Whether the targetFlow field is set.
   */
  boolean hasTargetFlow();
  /**
   *
   *
   *    * The target flow to transition to.
   * Format:
   * `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>`.
   * 
   *
   * string target_flow = 3 [(.google.api.resource_reference) = { ... }
   *
   * @return The targetFlow.
   */
  java.lang.String getTargetFlow();
  /**
   *
   *
   *    * The target flow to transition to.
   * Format:
   * `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>`.
   * 
   *
   * string target_flow = 3 [(.google.api.resource_reference) = { ... }
   *
   * @return The bytes for targetFlow.
   */
  com.google.protobuf.ByteString getTargetFlowBytes();

  /**
   *
   *
   *    * The target playbook to transition to.
   * Format:
   * `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>`.
   * 
   *
   * string target_playbook = 7 [(.google.api.resource_reference) = { ... }
   *
   * @return Whether the targetPlaybook field is set.
   */
  boolean hasTargetPlaybook();
  /**
   *
   *
   *    * The target playbook to transition to.
   * Format:
   * `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>`.
   * 
   *
   * string target_playbook = 7 [(.google.api.resource_reference) = { ... }
   *
   * @return The targetPlaybook.
   */
  java.lang.String getTargetPlaybook();
  /**
   *
   *
   *    * The target playbook to transition to.
   * Format:
   * `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>`.
   * 
   *
   * string target_playbook = 7 [(.google.api.resource_reference) = { ... }
   *
   * @return The bytes for targetPlaybook.
   */
  com.google.protobuf.ByteString getTargetPlaybookBytes();

  com.google.cloud.dialogflow.cx.v3beta1.EventHandler.TargetCase getTargetCase();
}