/*
 * Copyright 2023 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/v2beta1/human_agent_assistant_event.proto

package com.google.cloud.dialogflow.v2beta1;

public interface HumanAgentAssistantEventOrBuilder
    extends
    // @@protoc_insertion_point(interface_extends:google.cloud.dialogflow.v2beta1.HumanAgentAssistantEvent)
    com.google.protobuf.MessageOrBuilder {

  /**
   *
   *
   * <pre>
   * The conversation this notification refers to.
   * Format: `projects/&lt;Project ID&gt;/conversations/&lt;Conversation ID&gt;`.
   * </pre>
   *
   * <code>string conversation = 1;</code>
   *
   * @return The conversation.
   */
  java.lang.String getConversation();
  /**
   *
   *
   * <pre>
   * The conversation this notification refers to.
   * Format: `projects/&lt;Project ID&gt;/conversations/&lt;Conversation ID&gt;`.
   * </pre>
   *
   * <code>string conversation = 1;</code>
   *
   * @return The bytes for conversation.
   */
  com.google.protobuf.ByteString getConversationBytes();

  /**
   *
   *
   * <pre>
   * The participant that the suggestion is compiled for. And This field is used
   * to call
   * [Participants.ListSuggestions][google.cloud.dialogflow.v2beta1.Participants.ListSuggestions]
   * API. Format: `projects/&lt;Project ID&gt;/conversations/&lt;Conversation
   * ID&gt;/participants/&lt;Participant ID&gt;`.
   * It will not be set in legacy workflow.
   * [HumanAgentAssistantConfig.name][google.cloud.dialogflow.v2beta1.HumanAgentAssistantConfig.name]
   * for more information.
   * </pre>
   *
   * <code>string participant = 3;</code>
   *
   * @return The participant.
   */
  java.lang.String getParticipant();
  /**
   *
   *
   * <pre>
   * The participant that the suggestion is compiled for. And This field is used
   * to call
   * [Participants.ListSuggestions][google.cloud.dialogflow.v2beta1.Participants.ListSuggestions]
   * API. Format: `projects/&lt;Project ID&gt;/conversations/&lt;Conversation
   * ID&gt;/participants/&lt;Participant ID&gt;`.
   * It will not be set in legacy workflow.
   * [HumanAgentAssistantConfig.name][google.cloud.dialogflow.v2beta1.HumanAgentAssistantConfig.name]
   * for more information.
   * </pre>
   *
   * <code>string participant = 3;</code>
   *
   * @return The bytes for participant.
   */
  com.google.protobuf.ByteString getParticipantBytes();

  /**
   *
   *
   * <pre>
   * The suggestion results payload that this notification refers to. It will
   * only be set when
   * [HumanAgentAssistantConfig.SuggestionConfig.group_suggestion_responses][google.cloud.dialogflow.v2beta1.HumanAgentAssistantConfig.SuggestionConfig.group_suggestion_responses]
   * sets to true.
   * </pre>
   *
   * <code>repeated .google.cloud.dialogflow.v2beta1.SuggestionResult suggestion_results = 5;</code>
   */
  java.util.List<com.google.cloud.dialogflow.v2beta1.SuggestionResult> getSuggestionResultsList();
  /**
   *
   *
   * <pre>
   * The suggestion results payload that this notification refers to. It will
   * only be set when
   * [HumanAgentAssistantConfig.SuggestionConfig.group_suggestion_responses][google.cloud.dialogflow.v2beta1.HumanAgentAssistantConfig.SuggestionConfig.group_suggestion_responses]
   * sets to true.
   * </pre>
   *
   * <code>repeated .google.cloud.dialogflow.v2beta1.SuggestionResult suggestion_results = 5;</code>
   */
  com.google.cloud.dialogflow.v2beta1.SuggestionResult getSuggestionResults(int index);
  /**
   *
   *
   * <pre>
   * The suggestion results payload that this notification refers to. It will
   * only be set when
   * [HumanAgentAssistantConfig.SuggestionConfig.group_suggestion_responses][google.cloud.dialogflow.v2beta1.HumanAgentAssistantConfig.SuggestionConfig.group_suggestion_responses]
   * sets to true.
   * </pre>
   *
   * <code>repeated .google.cloud.dialogflow.v2beta1.SuggestionResult suggestion_results = 5;</code>
   */
  int getSuggestionResultsCount();
  /**
   *
   *
   * <pre>
   * The suggestion results payload that this notification refers to. It will
   * only be set when
   * [HumanAgentAssistantConfig.SuggestionConfig.group_suggestion_responses][google.cloud.dialogflow.v2beta1.HumanAgentAssistantConfig.SuggestionConfig.group_suggestion_responses]
   * sets to true.
   * </pre>
   *
   * <code>repeated .google.cloud.dialogflow.v2beta1.SuggestionResult suggestion_results = 5;</code>
   */
  java.util.List<? extends com.google.cloud.dialogflow.v2beta1.SuggestionResultOrBuilder>
      getSuggestionResultsOrBuilderList();
  /**
   *
   *
   * <pre>
   * The suggestion results payload that this notification refers to. It will
   * only be set when
   * [HumanAgentAssistantConfig.SuggestionConfig.group_suggestion_responses][google.cloud.dialogflow.v2beta1.HumanAgentAssistantConfig.SuggestionConfig.group_suggestion_responses]
   * sets to true.
   * </pre>
   *
   * <code>repeated .google.cloud.dialogflow.v2beta1.SuggestionResult suggestion_results = 5;</code>
   */
  com.google.cloud.dialogflow.v2beta1.SuggestionResultOrBuilder getSuggestionResultsOrBuilder(
      int index);
}
