com.google.cloud.documentai.v1beta3.ListDocumentsRequestOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of proto-google-cloud-document-ai-v1beta3 Show documentation
PROTO library for proto-google-cloud-document-ai-v1beta3
There is a newer version: 0.71.0
Show 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/documentai/v1beta3/document_service.proto

// Protobuf Java Version: 3.25.2
package com.google.cloud.documentai.v1beta3;

public interface ListDocumentsRequestOrBuilder
    extends
    // @@protoc_insertion_point(interface_extends:google.cloud.documentai.v1beta3.ListDocumentsRequest)
    com.google.protobuf.MessageOrBuilder {

  /**
   *
   *
   *    * Required. The resource name of the dataset to be listed.
   * Format:
   * projects/{project}/locations/{location}/processors/{processor}/dataset
   * 
   *
   * 
   * string dataset = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
   * 
   *
   * @return The dataset.
   */
  java.lang.String getDataset();
  /**
   *
   *
   *    * Required. The resource name of the dataset to be listed.
   * Format:
   * projects/{project}/locations/{location}/processors/{processor}/dataset
   * 
   *
   * 
   * string dataset = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
   * 
   *
   * @return The bytes for dataset.
   */
  com.google.protobuf.ByteString getDatasetBytes();

  /**
   *
   *
   *    * The maximum number of documents to return. The service may return
   * fewer than this value.
   * If unspecified, at most 20 documents will be returned.
   * The maximum value is 100; values above 100 will be coerced to 100.
   * 
   *
   * int32 page_size = 2;
   *
   * @return The pageSize.
   */
  int getPageSize();

  /**
   *
   *
   *    * A page token, received from a previous `ListDocuments` call.
   * Provide this to retrieve the subsequent page.
   *
   * When paginating, all other parameters provided to `ListDocuments`
   * must match the call that provided the page token.
   * 
   *
   * string page_token = 3;
   *
   * @return The pageToken.
   */
  java.lang.String getPageToken();
  /**
   *
   *
   *    * A page token, received from a previous `ListDocuments` call.
   * Provide this to retrieve the subsequent page.
   *
   * When paginating, all other parameters provided to `ListDocuments`
   * must match the call that provided the page token.
   * 
   *
   * string page_token = 3;
   *
   * @return The bytes for pageToken.
   */
  com.google.protobuf.ByteString getPageTokenBytes();

  /**
   *
   *
   *    * Optional. Query to filter the documents based on
   * https://google.aip.dev/160.
   * ## Currently support query strings are:
   *
   * `SplitType=DATASET_SPLIT_TEST|DATASET_SPLIT_TRAIN|DATASET_SPLIT_UNASSIGNED`
   * - `LabelingState=DOCUMENT_LABELED|DOCUMENT_UNLABELED|DOCUMENT_AUTO_LABELED`
   * - `DisplayName=\"file_name.pdf\"`
   * - `EntityType=abc/def`
   * - `TagName=\"auto-labeling-running\"|\"sampled\"`
   *
   * Note:
   * - Only `AND`, `=` and `!=` are supported.
   *     e.g. `DisplayName=file_name AND EntityType!=abc` IS supported.
   * - Wildcard `*` is supported only in `DisplayName` filter
   * - No duplicate filter keys are allowed,
   *     e.g. `EntityType=a AND EntityType=b` is NOT supported.
   * - String match is case sensitive (for filter `DisplayName` & `EntityType`).
   * 
   *
   * string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @return The filter.
   */
  java.lang.String getFilter();
  /**
   *
   *
   *    * Optional. Query to filter the documents based on
   * https://google.aip.dev/160.
   * ## Currently support query strings are:
   *
   * `SplitType=DATASET_SPLIT_TEST|DATASET_SPLIT_TRAIN|DATASET_SPLIT_UNASSIGNED`
   * - `LabelingState=DOCUMENT_LABELED|DOCUMENT_UNLABELED|DOCUMENT_AUTO_LABELED`
   * - `DisplayName=\"file_name.pdf\"`
   * - `EntityType=abc/def`
   * - `TagName=\"auto-labeling-running\"|\"sampled\"`
   *
   * Note:
   * - Only `AND`, `=` and `!=` are supported.
   *     e.g. `DisplayName=file_name AND EntityType!=abc` IS supported.
   * - Wildcard `*` is supported only in `DisplayName` filter
   * - No duplicate filter keys are allowed,
   *     e.g. `EntityType=a AND EntityType=b` is NOT supported.
   * - String match is case sensitive (for filter `DisplayName` & `EntityType`).
   * 
   *
   * string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @return The bytes for filter.
   */
  com.google.protobuf.ByteString getFilterBytes();

  /**
   *
   *
   *    * Optional. Controls if the request requires a total size of matched
   * documents. See
   * [ListDocumentsResponse.total_size][google.cloud.documentai.v1beta3.ListDocumentsResponse.total_size].
   *
   * Enabling this flag may adversely impact performance.
   *
   * Defaults to false.
   * 
   *
   * bool return_total_size = 6 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @return The returnTotalSize.
   */
  boolean getReturnTotalSize();

  /**
   *
   *
   *    * Optional. Number of results to skip beginning from the `page_token` if
   * provided. https://google.aip.dev/158#skipping-results. It must be a
   * non-negative integer. Negative values will be rejected. Note that this is
   * not the number of pages to skip. If this value causes the cursor to move
   * past the end of results,
   * [ListDocumentsResponse.document_metadata][google.cloud.documentai.v1beta3.ListDocumentsResponse.document_metadata]
   * and
   * [ListDocumentsResponse.next_page_token][google.cloud.documentai.v1beta3.ListDocumentsResponse.next_page_token]
   * will be empty.
   * 
   *
   * int32 skip = 8 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @return The skip.
   */
  int getSkip();
}