github.com/cloudwan/edgelq-sdk@v1.15.4/cellular-api/proto/v1/contract.proto (about)

     1  syntax = "proto3";
     2  
     3  package ntt.cellular_api.v1;
     4  
     5  import "google/api/resource.proto";
     6  import "goten-sdk/types/meta.proto";
     7  
     8  option go_package = "github.com/cloudwan/edgelq-sdk/cellular-api/resources/v1/contract;contract";
     9  option java_multiple_files = true;
    10  option java_outer_classname = "ContractProto";
    11  option java_package = "com.ntt.cellular_api.pb.v1";
    12  
    13  // Contract Resource
    14  message Contract {
    15    option (google.api.resource) = {
    16      type : "cellular-api.edgelq.com/Contract"
    17      pattern : "contracts/{contract}"
    18    };
    19  
    20    // Name of Contract
    21    // When creating a new instance, this field is optional and if not provided,
    22    // it will be generated automatically. Last ID segment must conform to the
    23    // following regex: [a-z][a-z0-9\\-]{0,28}[a-z0-9]
    24    string name = 1;
    25  
    26    // Metadata is an object with information like create, update and delete time
    27    // (for async deleted resources), has user labels/annotations, sharding
    28    // information, multi-region syncing information and may have non-schema
    29    // owners (useful for taking ownership of resources belonging to lower level
    30    // services by higher ones).
    31    goten.types.Meta metadata = 2;
    32  
    33    string rate_plan = 3;
    34  
    35    // CarrierAccount contains api credential for backend to call each carrier
    36    // APIs, therefore it is packed as a Secret resource. Secret resource itself
    37    // must contain following data field in each carrier:
    38    //
    39    // - Transatel
    40    // {
    41    //  "data": {
    42    //    "client_id": "<CLIENTID>",
    43    //    "client_secret": "<CLIENTSECRET>"
    44    //   }
    45    // }
    46    //
    47    // - Cisco
    48    // ..
    49    // - Celona
    50    // ..
    51    oneof carrier_account {
    52      string transatel = 5;
    53  
    54      string cisco = 6;
    55  
    56      string celona = 7;
    57    }
    58  }