Interface QueryOptions.PaginationOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
QueryOptions.Pagination, QueryOptions.Pagination.Builder
Enclosing class:
QueryOptions

public static interface QueryOptions.PaginationOrBuilder extends com.google.protobuf.MessageOrBuilder
  • Method Summary

    Modifier and Type
    Method
    Description
    int
    Sets a limit value for the number of results returned within a single page.
    int
    Sets an explicit offset; if specified, overrides `page`.
    int
    Sets the desired page number.

    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

    • getLimit

      int getLimit()
       Sets a limit value for the number of results returned within a single page.
       
      uint32 limit = 1 [json_name = "limit"];
      Returns:
      The limit.
    • getPage

      int getPage()
       Sets the desired page number.
       
      uint32 page = 2 [json_name = "page"];
      Returns:
      The page.
    • getOffset

      int getOffset()
       Sets an explicit offset; if specified, overrides `page`. If unspecified, calculated as `page * limit`.
       
      uint32 offset = 3 [json_name = "offset"];
      Returns:
      The offset.