github.com/muhammedhassanm/blockchain@v0.0.0-20200120143007-697261defd4d/sawtooth-core-master/protos/client_list_control.proto (about)

     1  // Copyright 2017 Intel Corporation
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //     http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  // -----------------------------------------------------------------------------
    15  
    16  syntax = "proto3";
    17  
    18  option java_multiple_files = true;
    19  option java_package = "sawtooth.sdk.protobuf";
    20  option go_package = "client_list_control_pb2";
    21  
    22  // Paging controls to be sent with List requests.
    23  // Attributes:
    24  //     start: The id of a resource to start the page with
    25  //     limit: The number of results per page, defaults to 100 and maxes out at 1000
    26  message ClientPagingControls {
    27      string start = 1;
    28      int32 limit = 2;
    29  }
    30  
    31  // Information about the pagination used, sent back with List responses.
    32  // Attributes:
    33  //     next: The id of the first resource in the next page
    34  //     start: The id of the first resource in the returned page
    35  //     limit: The number of results per page, defaults to 100 and maxes out at 1000
    36  message ClientPagingResponse {
    37      string next = 1;
    38      string start = 2;
    39      int32 limit = 3;
    40  
    41  }
    42  
    43  // Sorting controls to be sent with List requests. More than one can be sent.
    44  // If so, the first is used, and additional controls are tie-breakers.
    45  // Attributes:
    46  //     keys: Nested set of keys to sort by (i.e. ['default, block_num'])
    47  //     reverse: Whether or not to reverse the sort (i.e. descending order)
    48  message ClientSortControls {
    49      repeated string keys = 1;
    50      bool reverse = 2;
    51  }