github.com/cloudwan/edgelq-sdk@v1.15.4/devices/proto/v1/public_custom.proto (about)

     1  syntax = "proto3";
     2  
     3  package ntt.devices.v1;
     4  
     5  import "edgelq-sdk/devices/proto/v1/device.proto";
     6  import "edgelq-sdk/devices/proto/v1/device_change.proto";
     7  import "google/protobuf/field_mask.proto";
     8  import "goten-sdk/types/view.proto";
     9  
    10  option go_package = "github.com/cloudwan/edgelq-sdk/devices/client/v1/public;public_client";
    11  option java_multiple_files = false;
    12  option java_outer_classname = "PublicCustomProto";
    13  option java_package = "com.ntt.devices.pb.v1";
    14  
    15  // Request message for method
    16  // [ListPublicDevices][ntt.devices.v1.ListPublicDevices]
    17  message ListPublicDevicesRequest {
    18    // Parent name of ntt.devices.v1.Device
    19    string parent = 1;
    20  
    21    // Requested page size. Server may return fewer Devices than requested.
    22    // If unspecified, server will pick an appropriate default.
    23    int32 page_size = 2;
    24  
    25    // A token identifying a page of results the server should return.
    26    // Typically, this is the value of
    27    // [ListDevicesResponse.next_page_token][ntt.devices.v1.ListDevicesResponse.next_page_token]
    28    string page_token = 3;
    29  
    30    // Order By -
    31    // https://cloud.google.com/apis/design/design_patterns#list_pagination list
    32    // of field path with order directive, either 'asc' or 'desc'. If direction is
    33    // not provided, 'asc' is assumed. e.g. "state.nested_field asc,
    34    // state.something.else desc, theme"
    35    string order_by = 4;
    36  
    37    // Filter - filter results by field criteria. Simplified SQL-like syntax with
    38    // following operators:
    39    // <=, >=, =, !=, <, >, LIKE, CONTAINS (aliases CONTAIN, HAS, HAVE), IN, IS
    40    // [NOT] NULL | NaN . Combine conditions with OR | AND example: 'meta.labels
    41    // CONTAINS "severity:important" OR (state.last_error_time >
    42    // "2018-11-15T10:00:00Z" AND state.status = "ERROR")'
    43    string filter = 5;
    44  
    45    // A list of extra fields to be requested on top of those defined by request
    46    // field View.
    47    google.protobuf.FieldMask field_mask = 6;
    48  
    49    // View defines list of standard response fields present in response items.
    50    // Additional fields can be amended by request field field_mask
    51    goten.types.View view = 7;
    52  }
    53  
    54  // Response message for method
    55  // [ListPublicDevices][ntt.devices.v1.ListPublicDevices]
    56  message ListPublicDevicesResponse {
    57    // The list of Devices
    58    repeated Device devices = 1;
    59  
    60    // A token to retrieve previous page of results. Pass this value in the
    61    // [ListDevicesRequest.page_token][ntt.devices.v1.ListDevicesRequest.page_token]
    62    string prev_page_token = 3;
    63  
    64    // A token to retrieve next page of results. Pass this value in the
    65    // [ListDevicesRequest.page_token][ntt.devices.v1.ListDevicesRequest.page_token]
    66    string next_page_token = 4;
    67  }