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

     1  syntax = "proto3";
     2  
     3  package ntt.devices.v1;
     4  
     5  import "edgelq-sdk/cellular-api/proto/v1/sim_card.proto";
     6  import "google/api/resource.proto";
     7  import "goten-sdk/types/meta.proto";
     8  
     9  option go_package = "github.com/cloudwan/edgelq-sdk/devices/resources/v1/device_hardware;device_hardware";
    10  option java_multiple_files = true;
    11  option java_outer_classname = "DeviceHardwareProto";
    12  option java_package = "com.ntt.devices.pb.v1";
    13  
    14  // DeviceHardware Resource
    15  message DeviceHardware {
    16    option (google.api.resource) = {
    17      type : "devices.edgelq.com/DeviceHardware"
    18      pattern : "projects/{project}/regions/{region}/deviceHardwares/"
    19                "{device_hardware}"
    20    };
    21  
    22    // Name of DeviceHardware
    23    // When creating a new instance, this field is optional and if not provided,
    24    // it will be generated automatically. Last ID segment must conform to the
    25    // following regex: [a-z][a-z0-9\\-]{0,28}[a-z0-9]
    26    string name = 1;
    27  
    28    // Metadata is an object with information like create, update and delete time
    29    // (for async deleted resources), has user labels/annotations, sharding
    30    // information, multi-region syncing information and may have non-schema
    31    // owners (useful for taking ownership of resources belonging to lower level
    32    // services by higher ones).
    33    goten.types.Meta metadata = 2;
    34  
    35    string display_name = 3;
    36  
    37    string serial_number = 4;
    38  
    39    string manufacturer = 5;
    40  
    41    // Should be in the format "productname (sku)"
    42    string product_name = 6;
    43  
    44    repeated string mac_address = 7;
    45  
    46    // Result of activating sim card,
    47    // which is specified by associated_sim_card field
    48    string sim_iccid = 8;
    49  
    50    string imei = 9;
    51  
    52    string associated_provisioning_policy_name = 10;
    53  
    54    string associated_device = 11;
    55  
    56    string associated_sim_card = 13;
    57  
    58    Status status = 12;
    59  
    60    message Status {
    61      PROVISIONING_STATE provisioning_state = 1;
    62  
    63      enum PROVISIONING_STATE {
    64        // Hardware was deregistered, so device state cannot be tracked
    65        UNKNOWN = 0;
    66  
    67        // The SIM card is being activated.
    68        SIM_ACTIVATING = 4;
    69  
    70        // The device would be connecting to ZTP
    71        // as the attached SIM card was activated.
    72        // If SIM card is not attached, this is the first status.
    73        // If stuck at this value, provisioning could have failed.
    74        CONNECTING = 5;
    75  
    76        // Deprecated:
    77        // This has been replaced by splitting into
    78        // SIM_ACTIVATING and ZTP_CONNECTING
    79        NOT_PROVISIONED = 1 [ deprecated = true ];
    80  
    81        // Device passed attestation and service account is created
    82        // Could be either provisioning policy scope for device scope account
    83        PROVISIONED = 2;
    84  
    85        // For device scope onboarding, the device was removed
    86        // For provisioning policy based onboarding, the provisioning policy was
    87        // removed
    88        REVOKED = 3;
    89      }
    90    }
    91  }