common.proto 4.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153
  1. // Copyright 2021 Google LLC
  2. //
  3. // Licensed under the Apache License, Version 2.0 (the "License");
  4. // you may not use this file except in compliance with the License.
  5. // You may obtain a copy of the License at
  6. //
  7. // http://www.apache.org/licenses/LICENSE-2.0
  8. //
  9. // Unless required by applicable law or agreed to in writing, software
  10. // distributed under the License is distributed on an "AS IS" BASIS,
  11. // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12. // See the License for the specific language governing permissions and
  13. // limitations under the License.
  14. syntax = "proto3";
  15. package google.cloud.channel.v1;
  16. import "google/api/field_behavior.proto";
  17. import "google/protobuf/any.proto";
  18. import "google/api/annotations.proto";
  19. option go_package = "google.golang.org/genproto/googleapis/cloud/channel/v1;channel";
  20. option java_multiple_files = true;
  21. option java_outer_classname = "CommonProto";
  22. option java_package = "com.google.cloud.channel.v1";
  23. // Required Edu Attributes
  24. message EduData {
  25. // Enum to specify the institute type.
  26. enum InstituteType {
  27. // Default value. This state doesn't show unless an error occurs.
  28. INSTITUTE_TYPE_UNSPECIFIED = 0;
  29. // Elementary/Secondary Schools & Districts
  30. K12 = 1;
  31. // Higher Education Universities & Colleges
  32. UNIVERSITY = 2;
  33. }
  34. // Number of students and staff the institute has.
  35. enum InstituteSize {
  36. // Default value. This state doesn't show unless an error occurs.
  37. INSTITUTE_SIZE_UNSPECIFIED = 0;
  38. // 1 - 100
  39. SIZE_1_100 = 1;
  40. // 101 - 500
  41. SIZE_101_500 = 2;
  42. // 501 - 1,000
  43. SIZE_501_1000 = 3;
  44. // 1,001 - 2,000
  45. SIZE_1001_2000 = 4;
  46. // 2,001 - 5,000
  47. SIZE_2001_5000 = 5;
  48. // 5,001 - 10,000
  49. SIZE_5001_10000 = 6;
  50. // 10,001 +
  51. SIZE_10001_OR_MORE = 7;
  52. }
  53. // Designated institute type of customer.
  54. InstituteType institute_type = 1;
  55. // Size of the institute.
  56. InstituteSize institute_size = 2;
  57. // Web address for the edu customer's institution.
  58. string website = 3;
  59. }
  60. // Cloud Identity information for the Cloud Channel Customer.
  61. message CloudIdentityInfo {
  62. // CustomerType of the customer
  63. enum CustomerType {
  64. // Default value. This state doesn't show unless an error occurs.
  65. CUSTOMER_TYPE_UNSPECIFIED = 0;
  66. // Domain-owning customer which needs domain verification to use services.
  67. DOMAIN = 1;
  68. // Team customer which needs email verification to use services.
  69. TEAM = 2;
  70. }
  71. // CustomerType indicates verification type needed for using services.
  72. CustomerType customer_type = 1;
  73. // Output only. The primary domain name.
  74. string primary_domain = 9 [(google.api.field_behavior) = OUTPUT_ONLY];
  75. // Output only. Whether the domain is verified.
  76. // This field is not returned for a Customer's cloud_identity_info resource.
  77. // Partners can use the domains.get() method of the Workspace SDK's
  78. // Directory API, or listen to the PRIMARY_DOMAIN_VERIFIED Pub/Sub event in
  79. // to track domain verification of their resolve Workspace customers.
  80. bool is_domain_verified = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
  81. // The alternate email.
  82. string alternate_email = 6;
  83. // Phone number associated with the Cloud Identity.
  84. string phone_number = 7;
  85. // Language code.
  86. string language_code = 8;
  87. // Output only. URI of Customer's Admin console dashboard.
  88. string admin_console_uri = 10 [(google.api.field_behavior) = OUTPUT_ONLY];
  89. // Edu information about the customer.
  90. EduData edu_data = 22;
  91. }
  92. // Data type and value of a parameter.
  93. message Value {
  94. // The kind of value.
  95. oneof kind {
  96. // Represents an int64 value.
  97. int64 int64_value = 1;
  98. // Represents a string value.
  99. string string_value = 2;
  100. // Represents a double value.
  101. double double_value = 3;
  102. // Represents an 'Any' proto value.
  103. google.protobuf.Any proto_value = 4;
  104. // Represents a boolean value.
  105. bool bool_value = 5;
  106. }
  107. }
  108. // Information needed to create an Admin User for Google Workspace.
  109. message AdminUser {
  110. // Primary email of the admin user.
  111. string email = 1;
  112. // Given name of the admin user.
  113. string given_name = 2;
  114. // Family name of the admin user.
  115. string family_name = 3;
  116. }