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.

Source code in frequenz/api/common/v1/pagination/pagination_params_pb2.py

)
# @@protoc_insertion_point(imports)

_sym_db = _symbol_database.Default()




DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n9frequenz/api/common/v1/pagination/pagination_params.proto\x12!frequenz.api.common.v1.pagination\"G\n\x10PaginationParams\x12\x13\n\tpage_size\x18\x01 \x01(\rH\x00\x12\x14\n\npage_token\x18\x02 \x01(\tH\x00\x42\x08\n\x06paramsb\x06proto3')

_globals = globals()
_builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
_builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'frequenz.api.common.v1.pagination.pagination_params_pb2', _globals)
if not _descriptor._USE_C_DESCRIPTORS:
  DESCRIPTOR._loaded_options = None
  _globals['_PAGINATIONPARAMS']._serialized_start=96
  _globals['_PAGINATIONPARAMS']._serialized_end=167
# @@protoc_insertion_point(module_scope)

Attributes

page_size: builtins.int instance-attribute

The maximum number of results to return in a single page. The service may return fewer results than requested. If unspecified, the service may choose a reasonable default. May only be specified in the first request.

page_token: builtins.str instance-attribute

A token identifying a page of results to return. This should be the value of the next_page_token field in the previous response's PaginationInfo. For the first request, this field should be omitted.

To avoid keeping remembering the page_size across requests, service implementations may choose to encode the page_size in the page_token.