com.google.cloud.dialogflow.cx.v3beta1.FlowInvocationOrBuilder 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/example.proto

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

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

  /**
   *
   *
   *    * Required. The unique identifier of the flow.
   * Format:
   * `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>`.
   * 
   *
   * 
   * string flow = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
   * 
   *
   * @return The flow.
   */
  java.lang.String getFlow();
  /**
   *
   *
   *    * Required. The unique identifier of the flow.
   * Format:
   * `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>`.
   * 
   *
   * 
   * string flow = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
   * 
   *
   * @return The bytes for flow.
   */
  com.google.protobuf.ByteString getFlowBytes();

  /**
   *
   *
   *    * Optional. A list of input parameters for the flow.
   * 
   *
   * 
   * .google.protobuf.Struct input_action_parameters = 5 [(.google.api.field_behavior) = OPTIONAL];
   * 
   *
   * @return Whether the inputActionParameters field is set.
   */
  boolean hasInputActionParameters();
  /**
   *
   *
   *    * Optional. A list of input parameters for the flow.
   * 
   *
   * 
   * .google.protobuf.Struct input_action_parameters = 5 [(.google.api.field_behavior) = OPTIONAL];
   * 
   *
   * @return The inputActionParameters.
   */
  com.google.protobuf.Struct getInputActionParameters();
  /**
   *
   *
   *    * Optional. A list of input parameters for the flow.
   * 
   *
   * 
   * .google.protobuf.Struct input_action_parameters = 5 [(.google.api.field_behavior) = OPTIONAL];
   * 
   */
  com.google.protobuf.StructOrBuilder getInputActionParametersOrBuilder();

  /**
   *
   *
   *    * Optional. A list of output parameters generated by the flow invocation.
   * 
   *
   * 
   * .google.protobuf.Struct output_action_parameters = 6 [(.google.api.field_behavior) = OPTIONAL];
   * 
   *
   * @return Whether the outputActionParameters field is set.
   */
  boolean hasOutputActionParameters();
  /**
   *
   *
   *    * Optional. A list of output parameters generated by the flow invocation.
   * 
   *
   * 
   * .google.protobuf.Struct output_action_parameters = 6 [(.google.api.field_behavior) = OPTIONAL];
   * 
   *
   * @return The outputActionParameters.
   */
  com.google.protobuf.Struct getOutputActionParameters();
  /**
   *
   *
   *    * Optional. A list of output parameters generated by the flow invocation.
   * 
   *
   * 
   * .google.protobuf.Struct output_action_parameters = 6 [(.google.api.field_behavior) = OPTIONAL];
   * 
   */
  com.google.protobuf.StructOrBuilder getOutputActionParametersOrBuilder();

  /**
   *
   *
   *    * Required. Flow invocation's output state.
   * 
   *
   * 
   * .google.cloud.dialogflow.cx.v3beta1.OutputState flow_state = 4 [(.google.api.field_behavior) = REQUIRED];
   * 
   *
   * @return The enum numeric value on the wire for flowState.
   */
  int getFlowStateValue();
  /**
   *
   *
   *    * Required. Flow invocation's output state.
   * 
   *
   * 
   * .google.cloud.dialogflow.cx.v3beta1.OutputState flow_state = 4 [(.google.api.field_behavior) = REQUIRED];
   * 
   *
   * @return The flowState.
   */
  com.google.cloud.dialogflow.cx.v3beta1.OutputState getFlowState();
}