Skip to content

pagination_info_pb2

frequenz.api.common.v1.pagination.pagination_info_pb2 ¤

Generated protocol buffer code.

Classes¤

frequenz.api.common.v1.pagination.pagination_info_pb2.PaginationInfo ¤

Bases: Message

A message providing metadata about paginated list results. The PaginationInfo message delivers metadata concerning the paginated list results and should be appended to the response message of a list request. The total_items field must be set to the total count of items that adhere to the filter criteria defined in the request. The next_page_token field should be populated with the token to be used in the subsequent request to fetch the next page of results. If there are no additional results, the next_page_token field should be omitted.

Source code in frequenz/api/common/v1/pagination/pagination_info_pb2.py 
23
24
25
26
  DESCRIPTOR._options = None
  _globals['_PAGINATIONINFO']._serialized_start=94
  _globals['_PAGINATIONINFO']._serialized_end=181
# @@protoc_insertion_point(module_scope)
Attributes¤
next_page_token: builtins.str instance-attribute ¤

Token for retrieving the next set of results.

total_items: builtins.int instance-attribute ¤

The total number of items that match the filter criteria defined in the request.