com.google.cloud.visionai.v1.ListIndexEndpointsRequestOrBuilder 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 ListIndexEndpointsRequestOrBuilder
    extends
    // @@protoc_insertion_point(interface_extends:google.cloud.visionai.v1.ListIndexEndpointsRequest)
    com.google.protobuf.MessageOrBuilder {

  /**
   *
   *
   *    * Required. Format: `projects/{project}/locations/{location}`
   * 
   *
   * 
   * string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
   * 
   *
   * @return The parent.
   */
  java.lang.String getParent();
  /**
   *
   *
   *    * Required. Format: `projects/{project}/locations/{location}`
   * 
   *
   * 
   * string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
   * 
   *
   * @return The bytes for parent.
   */
  com.google.protobuf.ByteString getParentBytes();

  /**
   *
   *
   *    * Optional. Requested page size. Server may return fewer items than
   * requested. The service may return fewer than this value. If unspecified, a
   * page size of 50 will be used. The maximum value is 1000; values above 1000
   * will be coerced to 1000.
   * 
   *
   * int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @return The pageSize.
   */
  int getPageSize();

  /**
   *
   *
   *    * Optional. A token identifying a page of results the server should return.
   * 
   *
   * string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @return The pageToken.
   */
  java.lang.String getPageToken();
  /**
   *
   *
   *    * Optional. A token identifying a page of results the server should return.
   * 
   *
   * string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @return The bytes for pageToken.
   */
  com.google.protobuf.ByteString getPageTokenBytes();

  /**
   *
   *
   *    * Optional. The filter applied to the returned list.
   * We only support filtering for the `deployed_image_index.image_index` field.
   * However, to filter by a corpus instead of an image index, simply use
   * `deployed_image_index.corpus`, which will return all endpoints with
   * `deployed_image_index.image_index` inside of the given corpus.
   * A basic filter on image index would look like:
   *   deployed_image_index.image_index =
   *     "projects/123/locations/us-central1/corpora/my_corpus/imageIndexes/my_image_index"
   * A basic filter on corpus would look like:
   *   deployed_image_index.corpus =
   *     "projects/123/locations/us-central1/corpora/my_corpus"
   * 
   *
   * string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @return The filter.
   */
  java.lang.String getFilter();
  /**
   *
   *
   *    * Optional. The filter applied to the returned list.
   * We only support filtering for the `deployed_image_index.image_index` field.
   * However, to filter by a corpus instead of an image index, simply use
   * `deployed_image_index.corpus`, which will return all endpoints with
   * `deployed_image_index.image_index` inside of the given corpus.
   * A basic filter on image index would look like:
   *   deployed_image_index.image_index =
   *     "projects/123/locations/us-central1/corpora/my_corpus/imageIndexes/my_image_index"
   * A basic filter on corpus would look like:
   *   deployed_image_index.corpus =
   *     "projects/123/locations/us-central1/corpora/my_corpus"
   * 
   *
   * string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @return The bytes for filter.
   */
  com.google.protobuf.ByteString getFilterBytes();
}