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

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

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

  /**
   *
   *
   *    * Required. The agent to list all conversations for.
   * Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`.
   * 
   *
   * 
   * string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
   * 
   *
   * @return The parent.
   */
  java.lang.String getParent();
  /**
   *
   *
   *    * Required. The agent to list all conversations for.
   * Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`.
   * 
   *
   * 
   * string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
   * 
   *
   * @return The bytes for parent.
   */
  com.google.protobuf.ByteString getParentBytes();

  /**
   *
   *
   *    * Optional. The filter string. Supports filter by create_time,
   * metrics.has_end_interaction, metrics.has_live_agent_handoff,
   * intents.display_name, pages.display_name and flows.display_name. Timestamps
   * expect an [RFC-3339][https://datatracker.ietf.org/doc/html/rfc3339]
   * formatted string (e.g. 2012-04-21T11:30:00-04:00). UTC offsets are
   * supported. Some examples:
   *   1. By create time:
   *        create_time > "2022-04-21T11:30:00-04:00"
   *   2. By intent display name:
   *        intents.display_name : "billing"
   *   3. By end interaction signal:
   *        metrics.has_end_interaction = true
   * 
   *
   * string filter = 2 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @return The filter.
   */
  java.lang.String getFilter();
  /**
   *
   *
   *    * Optional. The filter string. Supports filter by create_time,
   * metrics.has_end_interaction, metrics.has_live_agent_handoff,
   * intents.display_name, pages.display_name and flows.display_name. Timestamps
   * expect an [RFC-3339][https://datatracker.ietf.org/doc/html/rfc3339]
   * formatted string (e.g. 2012-04-21T11:30:00-04:00). UTC offsets are
   * supported. Some examples:
   *   1. By create time:
   *        create_time > "2022-04-21T11:30:00-04:00"
   *   2. By intent display name:
   *        intents.display_name : "billing"
   *   3. By end interaction signal:
   *        metrics.has_end_interaction = true
   * 
   *
   * string filter = 2 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @return The bytes for filter.
   */
  com.google.protobuf.ByteString getFilterBytes();

  /**
   *
   *
   *    * Optional. The maximum number of items to return in a single page. By
   * default 100 and at most 1000.
   * 
   *
   * int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @return The pageSize.
   */
  int getPageSize();

  /**
   *
   *
   *    * Optional. The next_page_token value returned from a previous list request.
   * 
   *
   * string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @return The pageToken.
   */
  java.lang.String getPageToken();
  /**
   *
   *
   *    * Optional. The next_page_token value returned from a previous list request.
   * 
   *
   * string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @return The bytes for pageToken.
   */
  com.google.protobuf.ByteString getPageTokenBytes();
}