"""
@generated by mypy-protobuf.  Do not edit manually!
isort:skip_file
"""
import builtins
import google.protobuf.descriptor
import google.protobuf.message
import typing_extensions

DESCRIPTOR: google.protobuf.descriptor.FileDescriptor = ...

# PageRequest is to be embedded in gRPC request messages for efficient
# pagination. Ex:
#
#  message SomeRequest {
#          Foo some_parameter = 1;
#          PageRequest pagination = 2;
#  }
class PageRequest(google.protobuf.message.Message):
    DESCRIPTOR: google.protobuf.descriptor.Descriptor = ...
    KEY_FIELD_NUMBER: builtins.int
    OFFSET_FIELD_NUMBER: builtins.int
    LIMIT_FIELD_NUMBER: builtins.int
    COUNT_TOTAL_FIELD_NUMBER: builtins.int
    REVERSE_FIELD_NUMBER: builtins.int
    # key is a value returned in PageResponse.next_key to begin
    # querying the next page most efficiently. Only one of offset or key
    # should be set.
    key: builtins.bytes = ...
    # offset is a numeric offset that can be used when key is unavailable.
    # It is less efficient than using key. Only one of offset or key should
    # be set.
    offset: builtins.int = ...
    # limit is the total number of results to be returned in the result page.
    # If left empty it will default to a value to be set by each app.
    limit: builtins.int = ...
    # count_total is set to true  to indicate that the result set should include
    # a count of the total number of items available for pagination in UIs.
    # count_total is only respected when offset is used. It is ignored when key
    # is set.
    count_total: builtins.bool = ...
    # reverse is set to true if results are to be returned in the descending order.
    reverse: builtins.bool = ...
    def __init__(self,
        *,
        key : builtins.bytes = ...,
        offset : builtins.int = ...,
        limit : builtins.int = ...,
        count_total : builtins.bool = ...,
        reverse : builtins.bool = ...,
        ) -> None: ...
    def ClearField(self, field_name: typing_extensions.Literal[u"count_total",b"count_total",u"key",b"key",u"limit",b"limit",u"offset",b"offset",u"reverse",b"reverse"]) -> None: ...
global___PageRequest = PageRequest

# PageResponse is to be embedded in gRPC response messages where the
# corresponding request message has used PageRequest.
#
#  message SomeResponse {
#          repeated Bar results = 1;
#          PageResponse page = 2;
#  }
class PageResponse(google.protobuf.message.Message):
    DESCRIPTOR: google.protobuf.descriptor.Descriptor = ...
    NEXT_KEY_FIELD_NUMBER: builtins.int
    TOTAL_FIELD_NUMBER: builtins.int
    # next_key is the key to be passed to PageRequest.key to
    # query the next page most efficiently
    next_key: builtins.bytes = ...
    # total is total number of results available if PageRequest.count_total
    # was set, its value is undefined otherwise
    total: builtins.int = ...
    def __init__(self,
        *,
        next_key : builtins.bytes = ...,
        total : builtins.int = ...,
        ) -> None: ...
    def ClearField(self, field_name: typing_extensions.Literal[u"next_key",b"next_key",u"total",b"total"]) -> None: ...
global___PageResponse = PageResponse
