com.google.cloud.dialogflow.cx.v3beta1.TransitionRouteOrBuilder 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 TransitionRouteOrBuilder
    extends
    // @@protoc_insertion_point(interface_extends:google.cloud.dialogflow.cx.v3beta1.TransitionRoute)
    com.google.protobuf.MessageOrBuilder {

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

  /**
   *
   *
   *    * Optional. The description of the transition route. The maximum length is
   * 500 characters.
   * 
   *
   * string description = 8 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @return The description.
   */
  java.lang.String getDescription();
  /**
   *
   *
   *    * Optional. The description of the transition route. The maximum length is
   * 500 characters.
   * 
   *
   * string description = 8 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @return The bytes for description.
   */
  com.google.protobuf.ByteString getDescriptionBytes();

  /**
   *
   *
   *    * The unique identifier of an
   * [Intent][google.cloud.dialogflow.cx.v3beta1.Intent]. Format:
   * `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/intents/<IntentID>`.
   * Indicates that the transition can only happen when the given intent is
   * matched.
   * At least one of `intent` or `condition` must be specified. When both
   * `intent` and `condition` are specified, the transition can only happen
   * when both are fulfilled.
   * 
   *
   * string intent = 1 [(.google.api.resource_reference) = { ... }
   *
   * @return The intent.
   */
  java.lang.String getIntent();
  /**
   *
   *
   *    * The unique identifier of an
   * [Intent][google.cloud.dialogflow.cx.v3beta1.Intent]. Format:
   * `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/intents/<IntentID>`.
   * Indicates that the transition can only happen when the given intent is
   * matched.
   * At least one of `intent` or `condition` must be specified. When both
   * `intent` and `condition` are specified, the transition can only happen
   * when both are fulfilled.
   * 
   *
   * string intent = 1 [(.google.api.resource_reference) = { ... }
   *
   * @return The bytes for intent.
   */
  com.google.protobuf.ByteString getIntentBytes();

  /**
   *
   *
   *    * The condition to evaluate against [form
   * parameters][google.cloud.dialogflow.cx.v3beta1.Form.parameters] or [session
   * parameters][google.cloud.dialogflow.cx.v3beta1.SessionInfo.parameters].
   *
   * See the [conditions
   * reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition).
   * At least one of `intent` or `condition` must be specified. When both
   * `intent` and `condition` are specified, the transition can only happen
   * when both are fulfilled.
   * 
   *
   * string condition = 2;
   *
   * @return The condition.
   */
  java.lang.String getCondition();
  /**
   *
   *
   *    * The condition to evaluate against [form
   * parameters][google.cloud.dialogflow.cx.v3beta1.Form.parameters] or [session
   * parameters][google.cloud.dialogflow.cx.v3beta1.SessionInfo.parameters].
   *
   * See the [conditions
   * reference](https://cloud.google.com/dialogflow/cx/docs/reference/condition).
   * At least one of `intent` or `condition` must be specified. When both
   * `intent` and `condition` are specified, the transition can only happen
   * when both are fulfilled.
   * 
   *
   * string condition = 2;
   *
   * @return The bytes for condition.
   */
  com.google.protobuf.ByteString getConditionBytes();

  /**
   *
   *
   *    * The fulfillment to call when the condition is satisfied. At least one of
   * `trigger_fulfillment` and `target` must be specified. When both are
   * defined, `trigger_fulfillment` is executed first.
   * 
   *
   * .google.cloud.dialogflow.cx.v3beta1.Fulfillment trigger_fulfillment = 3;
   *
   * @return Whether the triggerFulfillment field is set.
   */
  boolean hasTriggerFulfillment();
  /**
   *
   *
   *    * The fulfillment to call when the condition is satisfied. At least one of
   * `trigger_fulfillment` and `target` must be specified. When both are
   * defined, `trigger_fulfillment` is executed first.
   * 
   *
   * .google.cloud.dialogflow.cx.v3beta1.Fulfillment trigger_fulfillment = 3;
   *
   * @return The triggerFulfillment.
   */
  com.google.cloud.dialogflow.cx.v3beta1.Fulfillment getTriggerFulfillment();
  /**
   *
   *
   *    * The fulfillment to call when the condition is satisfied. At least one of
   * `trigger_fulfillment` and `target` must be specified. When both are
   * defined, `trigger_fulfillment` is executed first.
   * 
   *
   * .google.cloud.dialogflow.cx.v3beta1.Fulfillment trigger_fulfillment = 3;
   */
  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 = 4 [(.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 = 4 [(.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 = 4 [(.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 = 5 [(.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 = 5 [(.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 = 5 [(.google.api.resource_reference) = { ... }
   *
   * @return The bytes for targetFlow.
   */
  com.google.protobuf.ByteString getTargetFlowBytes();

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