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

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