Package com.google.cloud.visionai.v1

Interface ListIndexesRequestOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    getPageSize()
    The maximum number of indexes to return.
    String
    getPageToken()
    A page token, received from a previous `ListIndexes` call.
    com.google.protobuf.ByteString
    getPageTokenBytes()
    A page token, received from a previous `ListIndexes` call.
    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. The parent corpus that owns this collection of indexes.
 Format:
 `projects/{project_number}/locations/{location}/corpora/{corpus}`
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The parent.

    • getParentBytes

      com.google.protobuf.ByteString getParentBytes()
       Required. The parent corpus that owns this collection of indexes.
 Format:
 `projects/{project_number}/locations/{location}/corpora/{corpus}`
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The bytes for parent.

    • getPageSize

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

    • getPageToken

      String getPageToken()
       A page token, received from a previous `ListIndexes` call.
 Provide this to retrieve the subsequent page.

 When paginating, all other parameters provided to `ListIndexes` must match
 the call that provided the page token.
      string page_token = 3;
      Returns:
      The pageToken.

    • getPageTokenBytes

      com.google.protobuf.ByteString getPageTokenBytes()
       A page token, received from a previous `ListIndexes` call.
 Provide this to retrieve the subsequent page.

 When paginating, all other parameters provided to `ListIndexes` must match
 the call that provided the page token.
      string page_token = 3;
      Returns:
      The bytes for pageToken.