github.com/cloudwan/edgelq-sdk@v1.15.4/devices/proto/v1alpha2/device_service.proto

syntax = "proto3";

package ntt.devices.v1alpha2;

import "edgelq-sdk/devices/proto/v1alpha2/device.proto";
import "edgelq-sdk/devices/proto/v1alpha2/device_change.proto";
import "edgelq-sdk/devices/proto/v1alpha2/device_custom.proto";
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/protobuf/empty.proto";
import "google/protobuf/field_mask.proto";
import "google/protobuf/timestamp.proto";
import "goten-sdk/types/view.proto";
import "goten-sdk/types/watch_type.proto";

option go_package = "github.com/cloudwan/edgelq-sdk/devices/client/v1alpha2/device;device_client";
option java_multiple_files = false;
option java_outer_classname = "DeviceServiceProto";
option java_package = "com.ntt.devices.pb.v1alpha2";

// A request message of the GetDevice method.
message GetDeviceRequest {
  // Name of ntt.devices.v1alpha2.Device
  string name = 1;

  // A list of extra fields to be obtained for each response item on top of
  // fields defined by request field view
  google.protobuf.FieldMask field_mask = 3;

  // View defines list of standard response fields present in response items.
  // Additional fields can be amended by request field field_mask
  goten.types.View view = 4;
}

// A request message of the BatchGetDevices method.
message BatchGetDevicesRequest {
  // Names of Devices
  repeated string names = 2;

  // A list of extra fields to be obtained for each response item on top of
  // fields defined by request field view
  google.protobuf.FieldMask field_mask = 3;

  // View defines list of standard response fields present in response items.
  // Additional fields can be amended by request field field_mask
  goten.types.View view = 4;

  reserved 1;
}

// A response message of the BatchGetDevices method.
message BatchGetDevicesResponse {
  // found Devices
  repeated Device devices = 1;

  // list of not found Devices
  repeated string missing = 2;
}

// A request message of the ListDevices method.
message ListDevicesRequest {
  // Parent name of ntt.devices.v1alpha2.Device
  string parent = 1;

  // Requested page size. Server may return fewer Devices than requested.
  // If unspecified, server will pick an appropriate default.
  int32 page_size = 2;

  // A token identifying a page of results the server should return.
  // Typically, this is the value of
  // ListDevicesResponse.next_page_token.
  string page_token = 3;

  // Order By -
  // https://cloud.google.com/apis/design/design_patterns#list_pagination list
  // of field path with order directive, either 'asc' or 'desc'. If direction is
  // not provided, 'asc' is assumed. e.g. "state.nested_field asc,
  // state.something.else desc, theme"
  string order_by = 4;

  // Filter - filter results by field criteria. Simplified SQL-like syntax with
  // following operators:
  // <=, >=, =, !=, <, >, LIKE, CONTAINS (aliases CONTAIN, HAS, HAVE), IN, IS
  // [NOT] NULL | NaN . Combine conditions with OR | AND example: 'meta.labels
  // CONTAINS "severity:important" OR (state.last_error_time >
  // "2018-11-15T10:00:00Z" AND state.status = "ERROR")'
  string filter = 5;

  // A list of extra fields to be obtained for each response item on top of
  // fields defined by request field view
  google.protobuf.FieldMask field_mask = 6;

  // View defines list of standard response fields present in response items.
  // Additional fields can be amended by request field field_mask
  goten.types.View view = 7;

  // Indicates if list response should contain total count and offset (fields
  // current_offset and total_results_count).
  bool include_paging_info = 8;
}

// A response message of the ListDevices method.
message ListDevicesResponse {
  // The list of Devices
  repeated Device devices = 1;

  // A token to retrieve previous page of results.
  //
  // Pass this value in the ListDevicesRequest.page_token.
  string prev_page_token = 3;

  // A token to retrieve next page of results.
  //
  // Pass this value in the ListDevicesRequest.page_token.
  string next_page_token = 4;

  // Current offset from the first page or 0 if no page tokens were given,
  // paging info was not requested or there was an error while trying to get
  // it). Page index can be computed from offset and limit provided in a
  // request.
  int32 current_offset = 5;

  // Number of total Devices across all pages or 0, if there are no items,
  // paging info was not requested or there was an error while trying to get it.
  int32 total_results_count = 6;
}

// A request message of the WatchDevice method.
message WatchDeviceRequest {
  // Name of ntt.devices.v1alpha2.Device
  string name = 1;

  // A list of extra fields to be obtained for each response item on top of
  // fields defined by request field view
  google.protobuf.FieldMask field_mask = 2;

  // View defines list of standard response fields present in response items.
  // Additional fields can be amended by request field field_mask
  goten.types.View view = 4;
}

// A response message of the WatchDevice method.
message WatchDeviceResponse { DeviceChange change = 1; }

// A request message of the WatchDevices method.
message WatchDevicesRequest {
  // Type of a watch. Identifies how server stream data to a client, which
  // fields in a request are allowed and which fields in response are relevant.
  goten.types.WatchType type = 9;

  // Parent name of ntt.devices.v1alpha2.Device
  string parent = 1;

  // Requested page size. Server may return fewer Devices than requested.
  // If unspecified, server will pick an appropriate default.
  // Can be populated only for stateful watch type.
  int32 page_size = 2;

  // A token identifying a page of results the server should return.
  // Can be populated only for stateful watch type.
  string page_token = 3;

  // Order By -
  // https://cloud.google.com/apis/design/design_patterns#list_pagination Can be
  // populated only for stateful watch type.
  string order_by = 4;

  // A token identifying watch resume point from previous session.
  // Can be populated only for stateless watch type.
  string resume_token = 10;

  // Point in the time from which we want to start getting updates. This field
  // can be populated only for stateless watch type and if resume token is not
  // known yet. If specified, initial snapshot will NOT be provided. It is
  // assumed client can obtain it using separate means. Watch responses will
  // contain resume tokens which should be used to resume broken connection.
  google.protobuf.Timestamp starting_time = 12;

  // Filter - filter results by field criteria. Simplified SQL-like syntax with
  // following operators:
  // <=, >=, =, !=, <, >, LIKE, CONTAINS (aliases CONTAIN, HAS, HAVE), IN, IS
  // [NOT] NULL | NaN . Combine conditions with OR | AND example: 'meta.labels
  // CONTAINS "severity:important" OR (state.last_error_time >
  // "2018-11-15T10:00:00Z" AND state.status = "ERROR")'
  string filter = 5;

  // A list of extra fields to be obtained for each response item on top of
  // fields defined by request field view Changes to Device that don't affect
  // any of masked fields won't be sent back.
  google.protobuf.FieldMask field_mask = 6;

  // View defines list of standard response fields present in response items.
  // Additional fields can be amended by request field field_mask Changes to
  // Device that don't affect any of masked fields won't be sent back.
  goten.types.View view = 8;

  // Maximum amount of changes in each response message. Query result response
  // is divided on the server side into chunks with size of a specified amount
  // to limit memory footprint of each message. Responses will hold information
  // whether more elements will continue for the actual change. If unspecified,
  // server will pick an appropriate default.
  int32 max_chunk_size = 11;
}

// A response message of the WatchDevices method.
message WatchDevicesResponse {
  // Changes of Devices
  repeated DeviceChange device_changes = 2;

  // If request specified max_chunk_size (or this limit was enforced if
  // stateless watch has been chosen), then responses with "full changeset" will
  // be divided into chunks. Client should keep receiving messages and, once
  // is_current has value true, combine this recent message with all previous
  // ones where is_current is false. If this is the first is_current in a whole
  // watch stream, then it means that client should have, at this moment,
  // contain snapshot of the current situation (or more accurately, snapshot of
  // situation at the moment of request). All Devices will be of type
  // Added/Current (depending on watch_type specified in the request). Further
  // responses will be incremental - however messages may still be chunked and
  // is_current logic still applies. is_current is always true for stateful
  // watch if max_chunk_size was left to 0.
  bool is_current = 4;

  // When present, PageTokens used for page navigation should be updated.
  // Present only if is_current is true (last chunk).
  PageTokenChange page_token_change = 3;

  // Token that can be used if current connection drops and client needs to
  // reconnect. Populated only for stateless watch type. Present only if
  // is_current is true (last chunk).
  string resume_token = 5;

  // Server may occasionally send information how many resources should client
  // have in its state so far (response message without any changes, but with
  // snapshot_size field specified). If client has different value than the one
  // sent by the server, then it should be treated by a client as an error and
  // should reconnect. If value is smaller then 0, then client should ignore
  // this field as unpopulated. This field should be checked only for stateless
  // watch. In stateful those kind of errors are handled by the server side.
  // Will be never sent together with is_current, is_soft_reset and
  // is_hard_reset flags.
  int64 snapshot_size = 6;

  // In case of internal issue server may send response message with this flag.
  // It indicates that client should drop all changes from recent responses
  // where is_current is false only! If last message had is_current set to true,
  // client should do nothing and process normally. Resume token received before
  // is still valid. This field should be checked only for stateless watch. In
  // stateful those kind of errors are handled by the server side. Will never be
  // sent along with is_current, is_hard_reset or snapshot_size.
  bool is_soft_reset = 7;

  // In case of internal issue server may send response message with this flag.
  // After receiving, client should clear whole state (drop all changes received
  // so far) as server will send new snapshot (Devices will contains changes of
  // type Current only). Any resume tokens should be discarded as well. This
  // field should be checked only for stateless watch. In stateful those kind of
  // errors are handled by the server side. Will never be sent along with
  // is_current, is_soft_reset or snapshot_size.
  bool is_hard_reset = 8;

  message PageTokenChange {
    // New token to retrieve previous page of results.
    string prev_page_token = 1;

    // New token to retrieve next page of results.
    string next_page_token = 2;
  }
}

// A request message of the CreateDevice method.
message CreateDeviceRequest {
  // Parent name of ntt.devices.v1alpha2.Device
  string parent = 1;

  // Device resource body
  Device device = 2;

  // Optional masking applied to response object to reduce message response
  // size.
  ResponseMask response_mask = 3;

  // ResponseMask allows client to reduce response message size.
  message ResponseMask {
    oneof masking {
      // If this flag has value true, then response will contain just empty
      // resource without any fields populated.
      bool skip_entire_response_body = 1;

      // If this field is populated, then resource in response will contain only
      // specific fields.
      google.protobuf.FieldMask body_mask = 2;
    }
  }
}

// A request message of the UpdateDevice method.
message UpdateDeviceRequest {
  // Device resource body
  Device device = 2;

  // FieldMask applied to request - change will be applied only for fields in
  // the mask
  google.protobuf.FieldMask update_mask = 3;

  // Conditional update applied to request if update should be executed only for
  // specific resource state. If this field is populated, then server will fetch
  // existing resource, compare with the one stored in the cas field (after
  // applying field mask) and proceed with update only and only if they match.
  // Otherwise RPC error Aborted will be returned.
  CAS cas = 4;

  // If set to true, and the resource is not found,
  // a new resource will be created.  In this situation,
  // 'field_mask' is ignored.
  //
  // https://google.aip.dev/134#create-or-update
  bool allow_missing = 5; // Optional masking applied to response object to

  // reduce message response size.
  ResponseMask response_mask = 6;

  // CAS - Compare and Swap. This object is used if user wants to make update
  // conditional based upon previous resource version.
  message CAS {
    // Conditional desired state of a resource before update.
    Device conditional_state = 1;

    // Field paths from conditional state of resource server should check and
    // compare.
    google.protobuf.FieldMask field_mask = 2;
  }

  // ResponseMask allows client to reduce response message size.
  message ResponseMask {
    oneof masking {
      // If this flag has value true, then response will contain just empty
      // resource without any fields populated. Field body_mask is ignored if
      // set.
      bool skip_entire_response_body = 1;

      // Include all fields that were actually updated during processing. Note
      // this may be larger than update mask if some fields were computed
      // additionally. Name is added as well.
      bool updated_fields_only = 2;

      // If this field is populated, then resource in response will contain only
      // specific fields. If skip_entire_response_body is true, this field is
      // ignored.
      google.protobuf.FieldMask body_mask = 3;
    }
  }
}

// A request message of the DeleteDevice method.
message DeleteDeviceRequest {
  // Name of ntt.devices.v1alpha2.Device
  string name = 1;

  // If set to true, and the resource is not found, method will be successful
  // and will not return NotFound error.
  bool allow_missing = 2;
}

// Device service API for Devices
service DeviceService {
  option (google.api.default_host) = "devices.edgelq.com";
  option (google.api.oauth_scopes) = "https://apis.edgelq.com";

  // GetDevice
  rpc GetDevice(GetDeviceRequest) returns (Device) {
    option (google.api.http) = {
      get : "/v1alpha2/{name=projects/*/regions/*/devices/*}"
    };
  }

  // BatchGetDevices
  rpc BatchGetDevices(BatchGetDevicesRequest)
      returns (BatchGetDevicesResponse) {
    option (google.api.http) = {
      get : "/v1alpha2/devices:batchGet"
    };
  }

  // ListDevices
  rpc ListDevices(ListDevicesRequest) returns (ListDevicesResponse) {
    option (google.api.http) = {
      get : "/v1alpha2/{parent=projects/*/regions/*}/devices"
    };
  }

  // WatchDevice
  rpc WatchDevice(WatchDeviceRequest) returns (stream WatchDeviceResponse) {
    option (google.api.http) = {
      post : "/v1alpha2/{name=projects/*/regions/*/devices/*}:watch"
    };
  }

  // WatchDevices
  rpc WatchDevices(WatchDevicesRequest) returns (stream WatchDevicesResponse) {
    option (google.api.http) = {
      post : "/v1alpha2/{parent=projects/*/regions/*}/devices:watch"
    };
  }

  // CreateDevice
  rpc CreateDevice(CreateDeviceRequest) returns (Device) {
    option (google.api.http) = {
      post : "/v1alpha2/{parent=projects/*/regions/*}/devices"
      body : "device"
    };
  }

  // UpdateDevice
  rpc UpdateDevice(UpdateDeviceRequest) returns (Device) {
    option (google.api.http) = {
      put : "/v1alpha2/{device.name=projects/*/regions/*/devices/*}"
      body : "device"
    };
  }

  // DeleteDevice
  rpc DeleteDevice(DeleteDeviceRequest) returns (google.protobuf.Empty) {
    option (google.api.http) = {
      delete : "/v1alpha2/{name=projects/*/regions/*/devices/*}"
    };
  }

  // ProvisionServiceAccountToDevice
  rpc ProvisionServiceAccountToDevice(ProvisionServiceAccountToDeviceRequest)
      returns (ProvisionServiceAccountToDeviceResponse) {
    option (google.api.http) = {
      post : "/v1alpha2/{name=projects/*/regions/*/devices/"
             "*}:provisionServiceAccountToDevice"
    };
  }

  // RemoveServiceAccountFromDevice
  rpc RemoveServiceAccountFromDevice(RemoveServiceAccountFromDeviceRequest)
      returns (RemoveServiceAccountFromDeviceResponse) {
    option (google.api.http) = {
      post : "/v1alpha2/{name=projects/*/regions/*/devices/"
             "*}:removeServiceAccountFromDevice"
    };
  }
}