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

     1  syntax = "proto3";
     2  
     3  package ntt.devices.v1;
     4  
     5  import "edgelq-sdk/devices/proto/v1/device_hardware.proto";
     6  import "google/api/field_behavior.proto";
     7  import "google/api/resource.proto";
     8  import "google/protobuf/timestamp.proto";
     9  import "goten-sdk/types/meta.proto";
    10  
    11  option go_package = "github.com/cloudwan/edgelq-sdk/devices/resources/v1/device_hardware_register_session;device_hardware_register_session";
    12  option java_multiple_files = true;
    13  option java_outer_classname = "DeviceHardwareRegisterSessionProto";
    14  option java_package = "com.ntt.devices.pb.v1";
    15  
    16  // DeviceHardwareRegisterSession Resource
    17  message DeviceHardwareRegisterSession {
    18    option (google.api.resource) = {
    19      type : "devices.edgelq.com/DeviceHardwareRegisterSession"
    20      pattern : "projects/{project}/regions/{region}/"
    21                "deviceHardwareRegisterSessions/"
    22                "{device_hardware_register_session}"
    23    };
    24  
    25    // Name of DeviceHardwareRegisterSession
    26    // When creating a new instance, this field is optional and if not provided,
    27    // it will be generated automatically. Last ID segment must conform to the
    28    // following regex: [a-z][a-z0-9\\-]{0,28}[a-z0-9]
    29    string name = 1;
    30  
    31    string display_name = 14;
    32  
    33    // Metadata is an object with information like create, update and delete time
    34    // (for async deleted resources), has user labels/annotations, sharding
    35    // information, multi-region syncing information and may have non-schema
    36    // owners (useful for taking ownership of resources belonging to lower level
    37    // services by higher ones).
    38    goten.types.Meta metadata = 2;
    39  
    40    // Start time, if not set, current time will be used
    41    google.protobuf.Timestamp start_time = 3;
    42  
    43    // Expiration time, if not set, will be set to 1 week from now
    44    google.protobuf.Timestamp expiration_time = 4;
    45  
    46    // Email address of the user who will register the hardware
    47    // Only used to send an email. Not used for identity/authorization
    48    string user_email = 5;
    49  
    50    // Inviter Email, automatically set from token, not accepted as input
    51    string inviter_email = 6 [ (google.api.field_behavior) = OUTPUT_ONLY ];
    52  
    53    // Email ISO language code. Defaults to "en-us" (American English).
    54    string language_code = 7;
    55  
    56    // Extra custom fields to further customize email.
    57    // Fields should be agreed between sender (usually UI) and documented in
    58    // the template of email service provider.
    59    map<string, string> extras = 8;
    60  
    61    // Provisioning Policy name to register hardware
    62    // one of provisioning_policy_name or device_name is required
    63    string provisioning_policy_name = 9;
    64  
    65    // Device name to register hardware
    66    string device_name = 10;
    67  
    68    // If true, only one hardware can be registered using this session
    69    // If false, multiple hardwares can be registered using this session
    70    bool single_use = 11;
    71  
    72    // auto-generated
    73    string token = 12;
    74  
    75    Status status = 13;
    76  
    77    message Status {
    78      // Device hardwares that were registered with this session
    79      // Deleted names are retailed for history
    80      repeated string device_hardwares = 1;
    81    }
    82  }