com.google.cloud.visionai.v1.ViewCollectionItemsRequestOrBuilder Maven / Gradle / Ivy

Go to download
/*
 * 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/visionai/v1/warehouse.proto

// Protobuf Java Version: 3.25.3
package com.google.cloud.visionai.v1;

public interface ViewCollectionItemsRequestOrBuilder
    extends
    // @@protoc_insertion_point(interface_extends:google.cloud.visionai.v1.ViewCollectionItemsRequest)
    com.google.protobuf.MessageOrBuilder {

  /**
   *
   *
   *    * Required. The collection to view. Format:
   * `projects/{project_number}/locations/{location}/corpora/{corpus}/collections/{collection}`
   * 
   *
   * 
   * string collection = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
   * 
   *
   * @return The collection.
   */
  java.lang.String getCollection();
  /**
   *
   *
   *    * Required. The collection to view. Format:
   * `projects/{project_number}/locations/{location}/corpora/{corpus}/collections/{collection}`
   * 
   *
   * 
   * string collection = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
   * 
   *
   * @return The bytes for collection.
   */
  com.google.protobuf.ByteString getCollectionBytes();

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

  /**
   *
   *
   *    * A page token, received from a previous `ViewCollectionItemsRequest` call.
   * Provide this to retrieve the subsequent page.
   *
   * When paginating, all other parameters provided to
   * `ViewCollectionItemsRequest` 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 `ViewCollectionItemsRequest` call.
   * Provide this to retrieve the subsequent page.
   *
   * When paginating, all other parameters provided to
   * `ViewCollectionItemsRequest` must match the call that provided the page
   * token.
   * 
   *
   * string page_token = 3;
   *
   * @return The bytes for pageToken.
   */
  com.google.protobuf.ByteString getPageTokenBytes();
}