Package com.google.cloud.visionai.v1

Interface ViewCollectionItemsRequestOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getCollection()
    Required.
    com.google.protobuf.ByteString
    getCollectionBytes()
    Required.
    int
    getPageSize()
    The maximum number of collections to return.
    String
    getPageToken()
    A page token, received from a previous `ViewCollectionItemsRequest` call.
    com.google.protobuf.ByteString
    getPageTokenBytes()
    A page token, received from a previous `ViewCollectionItemsRequest` call.

    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

    • getCollection

      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) = { ... }
      Returns:
      The collection.

    • getCollectionBytes

      com.google.protobuf.ByteString getCollectionBytes()
       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) = { ... }
      Returns:
      The bytes for collection.

    • getPageSize

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

    • getPageToken

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

    • getPageTokenBytes

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