Package com.google.cloud.visionai.v1

Interface ListIndexEndpointsRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
ListIndexEndpointsRequest, ListIndexEndpointsRequest.Builder
@Generated public interface ListIndexEndpointsRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getFilter()
    Optional.
    com.google.protobuf.ByteString
    getFilterBytes()
    Optional.
    int
    getPageSize()
    Optional.
    String
    getPageToken()
    Optional.
    com.google.protobuf.ByteString
    getPageTokenBytes()
    Optional.
    String
    getParent()
    Required.
    com.google.protobuf.ByteString
    getParentBytes()
    Required.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getParent

      String getParent()
       Required. Format: `projects/{project}/locations/{location}`
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The parent.

    • getParentBytes

      com.google.protobuf.ByteString getParentBytes()
       Required. Format: `projects/{project}/locations/{location}`
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The bytes for parent.

    • getPageSize

      int getPageSize()
       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];
      Returns:
      The pageSize.

    • getPageToken

      String getPageToken()
       Optional. A token identifying a page of results the server should return.
      string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The pageToken.

    • getPageTokenBytes

      com.google.protobuf.ByteString getPageTokenBytes()
       Optional. A token identifying a page of results the server should return.
      string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for pageToken.

    • getFilter

      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];
      Returns:
      The filter.

    • getFilterBytes

      com.google.protobuf.ByteString getFilterBytes()
       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];
      Returns:
      The bytes for filter.