1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47
/// PageRequest is to be embedded in gRPC request messages for efficient /// pagination. Ex: /// /// message SomeRequest { /// Foo some_parameter = 1; /// PageRequest pagination = 2; /// } #[derive(Clone, PartialEq, ::prost::Message)] pub struct PageRequest { /// 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. #[prost(bytes, tag="1")] pub key: std::vec::Vec<u8>, /// 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. #[prost(uint64, tag="2")] pub offset: u64, /// 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. #[prost(uint64, tag="3")] pub limit: u64, /// 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. #[prost(bool, tag="4")] pub count_total: bool, } /// 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; /// } #[derive(Clone, PartialEq, ::prost::Message)] pub struct PageResponse { /// next_key is the key to be passed to PageRequest.key to /// query the next page most efficiently #[prost(bytes, tag="1")] pub next_key: std::vec::Vec<u8>, /// total is total number of results available if PageRequest.count_total /// was set, its value is undefined otherwise #[prost(uint64, tag="2")] pub total: u64, }