Package com.google.cloud.visionai.v1

Interface ListCorporaRequestOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getFilter()
    The filter applied to the returned corpora list.
    com.google.protobuf.ByteString
    getFilterBytes()
    The filter applied to the returned corpora list.
    int
    getPageSize()
    Requested page size.
    String
    getPageToken()
    A token identifying a page of results for the server to return.
    com.google.protobuf.ByteString
    getPageTokenBytes()
    A token identifying a page of results for the server to return.
    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 resource name of the project from which to list corpora.
      string parent = 1 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The parent.

    • getParentBytes

      com.google.protobuf.ByteString getParentBytes()
       Required. The resource name of the project from which to list corpora.
      string parent = 1 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The bytes for parent.

    • getPageSize

      int getPageSize()
       Requested page size. API may return fewer results than requested.
 If negative, INVALID_ARGUMENT error will be returned.
 If unspecified or 0, API will pick a default size, which is 10.
 If the requested page size is larger than the maximum size, API will pick
 use the maximum size, which is 20.
      int32 page_size = 2;
      Returns:
      The pageSize.

    • getPageToken

      String getPageToken()
       A token identifying a page of results for the server to return.
 Typically obtained via
 [ListCorporaResponse.next_page_token][google.cloud.visionai.v1.ListCorporaResponse.next_page_token]
 of the previous
 [Warehouse.ListCorpora][google.cloud.visionai.v1.Warehouse.ListCorpora]
 call.
      string page_token = 3;
      Returns:
      The pageToken.

    • getPageTokenBytes

      com.google.protobuf.ByteString getPageTokenBytes()
       A token identifying a page of results for the server to return.
 Typically obtained via
 [ListCorporaResponse.next_page_token][google.cloud.visionai.v1.ListCorporaResponse.next_page_token]
 of the previous
 [Warehouse.ListCorpora][google.cloud.visionai.v1.Warehouse.ListCorpora]
 call.
      string page_token = 3;
      Returns:
      The bytes for pageToken.

    • getFilter

      String getFilter()
       The filter applied to the returned corpora list.
 Only the following restrictions are supported:
 `type=<Corpus.Type>`,
 `type!=<Corpus.Type>`.
      string filter = 5;
      Returns:
      The filter.

    • getFilterBytes

      com.google.protobuf.ByteString getFilterBytes()
       The filter applied to the returned corpora list.
 Only the following restrictions are supported:
 `type=<Corpus.Type>`,
 `type!=<Corpus.Type>`.
      string filter = 5;
      Returns:
      The bytes for filter.