Skip to content

pagination_params_pb2

frequenz.api.common.v1.pagination.pagination_params_pb2 ¤

Generated protocol buffer code.

Classes¤

frequenz.api.common.v1.pagination.pagination_params_pb2.PaginationParams ¤

Bases: Message

A message defining parameters for paginating list requests. It can be appended to a request message to specify the desired page of results and the maximum number of results per page. For initial requests (requesting the first page), the page_token should not be provided. For subsequent requests (requesting any page after the first), the next_page_token from the previous responses PaginationInfo must be supplied. The page_size should only be specified in the initial request and will be disregarded in subsequent requests.

Source code in frequenz/api/common/v1/pagination/pagination_params_pb2.py 
19
20
21
22
23
24
25
_builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'frequenz.api.common.v1.pagination.pagination_params_pb2', globals())
if _descriptor._USE_C_DESCRIPTORS == False:

  DESCRIPTOR._options = None
  _PAGINATIONPARAMS._serialized_start=96
  _PAGINATIONPARAMS._serialized_end=192
# @@protoc_insertion_point(module_scope)
Attributes¤
page_size: builtins.int instance-attribute ¤

The maximum number of results to be returned per request.

page_token: builtins.str instance-attribute ¤

The token identifying a specific page of the list results.