google-api-client 0.42.2 → 0.43.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (358) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +129 -0
  3. data/generated/google/apis/abusiveexperiencereport_v1.rb +1 -1
  4. data/generated/google/apis/abusiveexperiencereport_v1/classes.rb +8 -13
  5. data/generated/google/apis/abusiveexperiencereport_v1/service.rb +2 -3
  6. data/generated/google/apis/accessapproval_v1.rb +1 -1
  7. data/generated/google/apis/accessapproval_v1/classes.rb +9 -0
  8. data/generated/google/apis/accessapproval_v1/representations.rb +1 -0
  9. data/generated/google/apis/adexchangebuyer2_v2beta1.rb +1 -1
  10. data/generated/google/apis/adexchangebuyer2_v2beta1/classes.rb +523 -653
  11. data/generated/google/apis/adexchangebuyer2_v2beta1/service.rb +467 -631
  12. data/generated/google/apis/adexperiencereport_v1.rb +1 -1
  13. data/generated/google/apis/adexperiencereport_v1/classes.rb +11 -18
  14. data/generated/google/apis/adexperiencereport_v1/service.rb +2 -3
  15. data/generated/google/apis/admob_v1.rb +1 -1
  16. data/generated/google/apis/admob_v1/classes.rb +139 -270
  17. data/generated/google/apis/admob_v1/service.rb +11 -13
  18. data/generated/google/apis/alertcenter_v1beta1.rb +1 -1
  19. data/generated/google/apis/alertcenter_v1beta1/classes.rb +107 -138
  20. data/generated/google/apis/alertcenter_v1beta1/service.rb +50 -55
  21. data/generated/google/apis/analyticsreporting_v4.rb +1 -1
  22. data/generated/google/apis/analyticsreporting_v4/classes.rb +315 -399
  23. data/generated/google/apis/androiddeviceprovisioning_v1.rb +1 -1
  24. data/generated/google/apis/androiddeviceprovisioning_v1/classes.rb +193 -220
  25. data/generated/google/apis/androiddeviceprovisioning_v1/service.rb +55 -61
  26. data/generated/google/apis/androidenterprise_v1.rb +1 -1
  27. data/generated/google/apis/androidenterprise_v1/classes.rb +452 -557
  28. data/generated/google/apis/androidenterprise_v1/service.rb +181 -240
  29. data/generated/google/apis/androidmanagement_v1.rb +1 -1
  30. data/generated/google/apis/androidpublisher_v3.rb +1 -1
  31. data/generated/google/apis/androidpublisher_v3/classes.rb +281 -342
  32. data/generated/google/apis/androidpublisher_v3/service.rb +125 -153
  33. data/generated/google/apis/apigee_v1.rb +6 -7
  34. data/generated/google/apis/apigee_v1/classes.rb +733 -1180
  35. data/generated/google/apis/apigee_v1/service.rb +879 -1133
  36. data/generated/google/apis/appsmarket_v2.rb +1 -1
  37. data/generated/google/apis/bigtableadmin_v2.rb +1 -1
  38. data/generated/google/apis/bigtableadmin_v2/service.rb +1 -1
  39. data/generated/google/apis/billingbudgets_v1beta1.rb +1 -1
  40. data/generated/google/apis/billingbudgets_v1beta1/classes.rb +97 -118
  41. data/generated/google/apis/billingbudgets_v1beta1/service.rb +30 -33
  42. data/generated/google/apis/blogger_v2.rb +2 -3
  43. data/generated/google/apis/blogger_v2/classes.rb +1 -2
  44. data/generated/google/apis/blogger_v2/service.rb +1 -2
  45. data/generated/google/apis/blogger_v3.rb +2 -3
  46. data/generated/google/apis/blogger_v3/classes.rb +1 -2
  47. data/generated/google/apis/blogger_v3/service.rb +1 -2
  48. data/generated/google/apis/chromeuxreport_v1.rb +1 -1
  49. data/generated/google/apis/chromeuxreport_v1/classes.rb +55 -66
  50. data/generated/google/apis/classroom_v1.rb +1 -1
  51. data/generated/google/apis/classroom_v1/classes.rb +250 -365
  52. data/generated/google/apis/classroom_v1/service.rb +643 -902
  53. data/generated/google/apis/cloudasset_v1.rb +1 -1
  54. data/generated/google/apis/cloudasset_v1/classes.rb +15 -11
  55. data/generated/google/apis/cloudasset_v1/service.rb +62 -45
  56. data/generated/google/apis/cloudasset_v1beta1.rb +1 -1
  57. data/generated/google/apis/cloudasset_v1beta1/classes.rb +3 -1
  58. data/generated/google/apis/cloudasset_v1p4beta1.rb +1 -1
  59. data/generated/google/apis/cloudasset_v1p5beta1.rb +1 -1
  60. data/generated/google/apis/cloudasset_v1p5beta1/classes.rb +3 -1
  61. data/generated/google/apis/clouderrorreporting_v1beta1.rb +1 -1
  62. data/generated/google/apis/clouderrorreporting_v1beta1/classes.rb +7 -0
  63. data/generated/google/apis/clouderrorreporting_v1beta1/representations.rb +1 -0
  64. data/generated/google/apis/cloudsearch_v1.rb +1 -1
  65. data/generated/google/apis/cloudsearch_v1/classes.rb +1 -2
  66. data/generated/google/apis/compute_alpha.rb +1 -1
  67. data/generated/google/apis/compute_alpha/classes.rb +350 -20
  68. data/generated/google/apis/compute_alpha/representations.rb +100 -0
  69. data/generated/google/apis/compute_alpha/service.rb +15 -7
  70. data/generated/google/apis/compute_beta.rb +1 -1
  71. data/generated/google/apis/compute_beta/classes.rb +39 -14
  72. data/generated/google/apis/compute_beta/representations.rb +2 -0
  73. data/generated/google/apis/compute_beta/service.rb +15 -7
  74. data/generated/google/apis/compute_v1.rb +1 -1
  75. data/generated/google/apis/compute_v1/classes.rb +65 -42
  76. data/generated/google/apis/compute_v1/representations.rb +18 -15
  77. data/generated/google/apis/compute_v1/service.rb +63 -19
  78. data/generated/google/apis/container_v1.rb +1 -1
  79. data/generated/google/apis/container_v1/classes.rb +26 -0
  80. data/generated/google/apis/container_v1/representations.rb +15 -0
  81. data/generated/google/apis/content_v2.rb +1 -1
  82. data/generated/google/apis/content_v2/classes.rb +9 -0
  83. data/generated/google/apis/content_v2_1.rb +1 -1
  84. data/generated/google/apis/content_v2_1/classes.rb +9 -0
  85. data/generated/google/apis/customsearch_v1.rb +1 -1
  86. data/generated/google/apis/customsearch_v1/classes.rb +303 -492
  87. data/generated/google/apis/customsearch_v1/service.rb +184 -341
  88. data/generated/google/apis/datacatalog_v1beta1.rb +1 -1
  89. data/generated/google/apis/datacatalog_v1beta1/classes.rb +572 -380
  90. data/generated/google/apis/datacatalog_v1beta1/service.rb +440 -319
  91. data/generated/google/apis/datafusion_v1.rb +43 -0
  92. data/generated/google/apis/datafusion_v1/classes.rb +1154 -0
  93. data/generated/google/apis/datafusion_v1/representations.rb +390 -0
  94. data/generated/google/apis/datafusion_v1/service.rb +680 -0
  95. data/generated/google/apis/dataproc_v1.rb +1 -1
  96. data/generated/google/apis/dataproc_v1/classes.rb +192 -316
  97. data/generated/google/apis/dataproc_v1/service.rb +134 -168
  98. data/generated/google/apis/dataproc_v1beta2.rb +1 -1
  99. data/generated/google/apis/dataproc_v1beta2/classes.rb +198 -317
  100. data/generated/google/apis/dataproc_v1beta2/service.rb +137 -192
  101. data/generated/google/apis/deploymentmanager_alpha.rb +1 -1
  102. data/generated/google/apis/deploymentmanager_v2beta.rb +1 -1
  103. data/generated/google/apis/dialogflow_v2.rb +1 -1
  104. data/generated/google/apis/dialogflow_v2/classes.rb +1238 -1589
  105. data/generated/google/apis/dialogflow_v2/service.rb +324 -448
  106. data/generated/google/apis/dialogflow_v2beta1.rb +1 -1
  107. data/generated/google/apis/dialogflow_v2beta1/classes.rb +1313 -1681
  108. data/generated/google/apis/dialogflow_v2beta1/service.rb +742 -998
  109. data/generated/google/apis/displayvideo_v1.rb +1 -1
  110. data/generated/google/apis/displayvideo_v1/classes.rb +104 -0
  111. data/generated/google/apis/displayvideo_v1/representations.rb +36 -0
  112. data/generated/google/apis/displayvideo_v1/service.rb +104 -0
  113. data/generated/google/apis/dlp_v2.rb +1 -1
  114. data/generated/google/apis/dlp_v2/classes.rb +5 -4
  115. data/generated/google/apis/dns_v1.rb +1 -1
  116. data/generated/google/apis/dns_v1/classes.rb +7 -7
  117. data/generated/google/apis/dns_v1beta2.rb +1 -1
  118. data/generated/google/apis/dns_v1beta2/classes.rb +7 -7
  119. data/generated/google/apis/dns_v2beta1.rb +1 -1
  120. data/generated/google/apis/dns_v2beta1/classes.rb +7 -7
  121. data/generated/google/apis/domainsrdap_v1.rb +1 -1
  122. data/generated/google/apis/domainsrdap_v1/classes.rb +42 -69
  123. data/generated/google/apis/domainsrdap_v1/service.rb +16 -16
  124. data/generated/google/apis/doubleclickbidmanager_v1.rb +1 -1
  125. data/generated/google/apis/doubleclickbidmanager_v1/classes.rb +1 -1
  126. data/generated/google/apis/doubleclickbidmanager_v1/service.rb +4 -2
  127. data/generated/google/apis/doubleclickbidmanager_v1_1.rb +1 -1
  128. data/generated/google/apis/doubleclickbidmanager_v1_1/classes.rb +196 -1
  129. data/generated/google/apis/doubleclickbidmanager_v1_1/representations.rb +107 -0
  130. data/generated/google/apis/doubleclickbidmanager_v1_1/service.rb +4 -2
  131. data/generated/google/apis/drive_v2.rb +1 -1
  132. data/generated/google/apis/drive_v2/classes.rb +3 -1
  133. data/generated/google/apis/drive_v3.rb +1 -1
  134. data/generated/google/apis/drive_v3/classes.rb +9 -1
  135. data/generated/google/apis/drive_v3/representations.rb +1 -0
  136. data/generated/google/apis/driveactivity_v2.rb +1 -1
  137. data/generated/google/apis/driveactivity_v2/classes.rb +55 -68
  138. data/generated/google/apis/factchecktools_v1alpha1.rb +1 -1
  139. data/generated/google/apis/factchecktools_v1alpha1/classes.rb +46 -56
  140. data/generated/google/apis/factchecktools_v1alpha1/service.rb +30 -33
  141. data/generated/google/apis/firebase_v1beta1.rb +1 -1
  142. data/generated/google/apis/firebase_v1beta1/classes.rb +313 -345
  143. data/generated/google/apis/firebase_v1beta1/representations.rb +1 -0
  144. data/generated/google/apis/firebase_v1beta1/service.rb +356 -420
  145. data/generated/google/apis/firebasedynamiclinks_v1.rb +1 -1
  146. data/generated/google/apis/firebasedynamiclinks_v1/classes.rb +89 -112
  147. data/generated/google/apis/firebasedynamiclinks_v1/service.rb +18 -21
  148. data/generated/google/apis/firebasehosting_v1.rb +1 -1
  149. data/generated/google/apis/firebasehosting_v1/classes.rb +36 -40
  150. data/generated/google/apis/firebasehosting_v1/service.rb +19 -22
  151. data/generated/google/apis/firebasehosting_v1beta1.rb +1 -1
  152. data/generated/google/apis/firebasehosting_v1beta1/classes.rb +148 -177
  153. data/generated/google/apis/firebasehosting_v1beta1/service.rb +112 -145
  154. data/generated/google/apis/firebaseml_v1.rb +1 -1
  155. data/generated/google/apis/firebaseml_v1/classes.rb +39 -44
  156. data/generated/google/apis/firebaseml_v1/service.rb +19 -22
  157. data/generated/google/apis/firebaseml_v1beta2.rb +1 -1
  158. data/generated/google/apis/firebaseml_v1beta2/classes.rb +60 -70
  159. data/generated/google/apis/firebaseml_v1beta2/service.rb +16 -18
  160. data/generated/google/apis/gameservices_v1.rb +1 -1
  161. data/generated/google/apis/gameservices_v1/classes.rb +344 -523
  162. data/generated/google/apis/gameservices_v1/service.rb +167 -207
  163. data/generated/google/apis/gameservices_v1beta.rb +1 -1
  164. data/generated/google/apis/gameservices_v1beta/classes.rb +344 -523
  165. data/generated/google/apis/gameservices_v1beta/service.rb +167 -207
  166. data/generated/google/apis/genomics_v1.rb +1 -1
  167. data/generated/google/apis/genomics_v1alpha2.rb +1 -1
  168. data/generated/google/apis/genomics_v2alpha1.rb +1 -1
  169. data/generated/google/apis/genomics_v2alpha1/classes.rb +3 -75
  170. data/generated/google/apis/genomics_v2alpha1/representations.rb +0 -27
  171. data/generated/google/apis/genomics_v2alpha1/service.rb +0 -34
  172. data/generated/google/apis/gmail_v1.rb +3 -3
  173. data/generated/google/apis/gmail_v1/classes.rb +216 -269
  174. data/generated/google/apis/gmail_v1/service.rb +257 -286
  175. data/generated/google/apis/gmailpostmastertools_v1beta1.rb +1 -1
  176. data/generated/google/apis/gmailpostmastertools_v1beta1/classes.rb +37 -42
  177. data/generated/google/apis/gmailpostmastertools_v1beta1/service.rb +34 -40
  178. data/generated/google/apis/healthcare_v1.rb +1 -1
  179. data/generated/google/apis/healthcare_v1/service.rb +26 -14
  180. data/generated/google/apis/healthcare_v1beta1.rb +1 -1
  181. data/generated/google/apis/healthcare_v1beta1/classes.rb +85 -17
  182. data/generated/google/apis/healthcare_v1beta1/representations.rb +39 -0
  183. data/generated/google/apis/healthcare_v1beta1/service.rb +87 -16
  184. data/generated/google/apis/language_v1.rb +1 -1
  185. data/generated/google/apis/language_v1/classes.rb +93 -111
  186. data/generated/google/apis/language_v1/service.rb +4 -4
  187. data/generated/google/apis/language_v1beta1.rb +1 -1
  188. data/generated/google/apis/language_v1beta1/classes.rb +78 -90
  189. data/generated/google/apis/language_v1beta1/service.rb +2 -2
  190. data/generated/google/apis/language_v1beta2.rb +1 -1
  191. data/generated/google/apis/language_v1beta2/classes.rb +95 -112
  192. data/generated/google/apis/language_v1beta2/service.rb +4 -4
  193. data/generated/google/apis/libraryagent_v1.rb +1 -1
  194. data/generated/google/apis/libraryagent_v1/classes.rb +10 -16
  195. data/generated/google/apis/libraryagent_v1/service.rb +13 -16
  196. data/generated/google/apis/logging_v2.rb +1 -1
  197. data/generated/google/apis/logging_v2/classes.rb +6 -6
  198. data/generated/google/apis/managedidentities_v1.rb +1 -1
  199. data/generated/google/apis/managedidentities_v1/classes.rb +326 -452
  200. data/generated/google/apis/managedidentities_v1/service.rb +78 -99
  201. data/generated/google/apis/managedidentities_v1alpha1.rb +1 -1
  202. data/generated/google/apis/managedidentities_v1alpha1/classes.rb +336 -457
  203. data/generated/google/apis/managedidentities_v1alpha1/service.rb +88 -112
  204. data/generated/google/apis/managedidentities_v1beta1.rb +1 -1
  205. data/generated/google/apis/managedidentities_v1beta1/classes.rb +332 -456
  206. data/generated/google/apis/managedidentities_v1beta1/service.rb +76 -96
  207. data/generated/google/apis/memcache_v1.rb +35 -0
  208. data/generated/google/apis/memcache_v1/classes.rb +1157 -0
  209. data/generated/google/apis/memcache_v1/representations.rb +471 -0
  210. data/generated/google/apis/memcache_v1/service.rb +558 -0
  211. data/generated/google/apis/memcache_v1beta2.rb +1 -1
  212. data/generated/google/apis/memcache_v1beta2/classes.rb +41 -502
  213. data/generated/google/apis/memcache_v1beta2/representations.rb +9 -110
  214. data/generated/google/apis/memcache_v1beta2/service.rb +0 -119
  215. data/generated/google/apis/monitoring_v1.rb +1 -1
  216. data/generated/google/apis/monitoring_v1/classes.rb +12 -11
  217. data/generated/google/apis/monitoring_v3.rb +1 -1
  218. data/generated/google/apis/monitoring_v3/classes.rb +31 -14
  219. data/generated/google/apis/monitoring_v3/representations.rb +2 -0
  220. data/generated/google/apis/osconfig_v1.rb +1 -1
  221. data/generated/google/apis/osconfig_v1/classes.rb +721 -0
  222. data/generated/google/apis/osconfig_v1/representations.rb +337 -0
  223. data/generated/google/apis/people_v1.rb +1 -1
  224. data/generated/google/apis/people_v1/classes.rb +148 -13
  225. data/generated/google/apis/people_v1/representations.rb +57 -0
  226. data/generated/google/apis/people_v1/service.rb +60 -48
  227. data/generated/google/apis/playcustomapp_v1.rb +1 -1
  228. data/generated/google/apis/playcustomapp_v1/classes.rb +2 -2
  229. data/generated/google/apis/policytroubleshooter_v1.rb +1 -1
  230. data/generated/google/apis/policytroubleshooter_v1/classes.rb +232 -394
  231. data/generated/google/apis/policytroubleshooter_v1/service.rb +2 -2
  232. data/generated/google/apis/policytroubleshooter_v1beta.rb +1 -1
  233. data/generated/google/apis/policytroubleshooter_v1beta/classes.rb +232 -393
  234. data/generated/google/apis/policytroubleshooter_v1beta/service.rb +2 -2
  235. data/generated/google/apis/prod_tt_sasportal_v1alpha1.rb +1 -1
  236. data/generated/google/apis/prod_tt_sasportal_v1alpha1/classes.rb +122 -146
  237. data/generated/google/apis/prod_tt_sasportal_v1alpha1/service.rb +38 -49
  238. data/generated/google/apis/realtimebidding_v1.rb +1 -4
  239. data/generated/google/apis/realtimebidding_v1/classes.rb +198 -291
  240. data/generated/google/apis/realtimebidding_v1/service.rb +98 -135
  241. data/generated/google/apis/recommendationengine_v1beta1.rb +2 -2
  242. data/generated/google/apis/recommendationengine_v1beta1/classes.rb +10 -8
  243. data/generated/google/apis/recommendationengine_v1beta1/service.rb +1 -1
  244. data/generated/google/apis/recommender_v1.rb +1 -1
  245. data/generated/google/apis/recommender_v1/classes.rb +76 -100
  246. data/generated/google/apis/recommender_v1/service.rb +43 -58
  247. data/generated/google/apis/recommender_v1beta1.rb +1 -1
  248. data/generated/google/apis/recommender_v1beta1/classes.rb +75 -99
  249. data/generated/google/apis/recommender_v1beta1/service.rb +43 -58
  250. data/generated/google/apis/run_v1.rb +1 -1
  251. data/generated/google/apis/run_v1/classes.rb +2 -2
  252. data/generated/google/apis/run_v1/service.rb +38 -2
  253. data/generated/google/apis/runtimeconfig_v1.rb +1 -1
  254. data/generated/google/apis/runtimeconfig_v1/classes.rb +36 -40
  255. data/generated/google/apis/runtimeconfig_v1/service.rb +19 -22
  256. data/generated/google/apis/sasportal_v1alpha1.rb +1 -1
  257. data/generated/google/apis/sasportal_v1alpha1/classes.rb +122 -146
  258. data/generated/google/apis/sasportal_v1alpha1/service.rb +38 -49
  259. data/generated/google/apis/searchconsole_v1.rb +1 -1
  260. data/generated/google/apis/searchconsole_v1/classes.rb +2 -2
  261. data/generated/google/apis/securitycenter_v1.rb +1 -1
  262. data/generated/google/apis/securitycenter_v1/classes.rb +574 -826
  263. data/generated/google/apis/securitycenter_v1/service.rb +250 -332
  264. data/generated/google/apis/securitycenter_v1beta1.rb +1 -1
  265. data/generated/google/apis/securitycenter_v1beta1/classes.rb +521 -746
  266. data/generated/google/apis/securitycenter_v1beta1/service.rb +160 -202
  267. data/generated/google/apis/securitycenter_v1p1alpha1.rb +1 -1
  268. data/generated/google/apis/securitycenter_v1p1alpha1/classes.rb +176 -208
  269. data/generated/google/apis/securitycenter_v1p1alpha1/service.rb +21 -25
  270. data/generated/google/apis/securitycenter_v1p1beta1.rb +1 -1
  271. data/generated/google/apis/securitycenter_v1p1beta1/classes.rb +545 -791
  272. data/generated/google/apis/securitycenter_v1p1beta1/service.rb +247 -330
  273. data/generated/google/apis/serviceconsumermanagement_v1.rb +1 -1
  274. data/generated/google/apis/serviceconsumermanagement_v1/classes.rb +1149 -1783
  275. data/generated/google/apis/serviceconsumermanagement_v1/service.rb +111 -138
  276. data/generated/google/apis/serviceconsumermanagement_v1beta1.rb +1 -1
  277. data/generated/google/apis/serviceconsumermanagement_v1beta1/classes.rb +1137 -1774
  278. data/generated/google/apis/serviceconsumermanagement_v1beta1/service.rb +52 -66
  279. data/generated/google/apis/servicecontrol_v2.rb +38 -0
  280. data/generated/google/apis/servicecontrol_v2/classes.rb +1121 -0
  281. data/generated/google/apis/servicecontrol_v2/representations.rb +405 -0
  282. data/generated/google/apis/servicecontrol_v2/service.rb +165 -0
  283. data/generated/google/apis/servicemanagement_v1.rb +1 -1
  284. data/generated/google/apis/servicemanagement_v1/classes.rb +49 -1
  285. data/generated/google/apis/servicemanagement_v1/representations.rb +14 -0
  286. data/generated/google/apis/servicenetworking_v1.rb +1 -1
  287. data/generated/google/apis/servicenetworking_v1/classes.rb +1119 -1758
  288. data/generated/google/apis/servicenetworking_v1/service.rb +94 -114
  289. data/generated/google/apis/servicenetworking_v1beta.rb +1 -1
  290. data/generated/google/apis/servicenetworking_v1beta/classes.rb +1065 -1684
  291. data/generated/google/apis/servicenetworking_v1beta/service.rb +52 -63
  292. data/generated/google/apis/serviceusage_v1.rb +1 -1
  293. data/generated/google/apis/serviceusage_v1/classes.rb +1140 -1823
  294. data/generated/google/apis/serviceusage_v1/service.rb +63 -80
  295. data/generated/google/apis/serviceusage_v1beta1.rb +1 -1
  296. data/generated/google/apis/serviceusage_v1beta1/classes.rb +1235 -1986
  297. data/generated/google/apis/serviceusage_v1beta1/service.rb +130 -162
  298. data/generated/google/apis/spanner_v1.rb +1 -1
  299. data/generated/google/apis/spanner_v1/classes.rb +3 -2
  300. data/generated/google/apis/storagetransfer_v1.rb +1 -1
  301. data/generated/google/apis/storagetransfer_v1/classes.rb +8 -10
  302. data/generated/google/apis/storagetransfer_v1/service.rb +26 -2
  303. data/generated/google/apis/tagmanager_v1.rb +2 -3
  304. data/generated/google/apis/tagmanager_v1/classes.rb +225 -288
  305. data/generated/google/apis/tagmanager_v1/service.rb +20 -21
  306. data/generated/google/apis/tagmanager_v2.rb +2 -3
  307. data/generated/google/apis/tagmanager_v2/classes.rb +240 -280
  308. data/generated/google/apis/tagmanager_v2/representations.rb +1 -0
  309. data/generated/google/apis/tagmanager_v2/service.rb +187 -283
  310. data/generated/google/apis/toolresults_v1beta3.rb +1 -1
  311. data/generated/google/apis/toolresults_v1beta3/classes.rb +665 -931
  312. data/generated/google/apis/toolresults_v1beta3/service.rb +231 -349
  313. data/generated/google/apis/tpu_v1.rb +1 -1
  314. data/generated/google/apis/tpu_v1/classes.rb +68 -78
  315. data/generated/google/apis/tpu_v1/service.rb +21 -25
  316. data/generated/google/apis/tpu_v1alpha1.rb +1 -1
  317. data/generated/google/apis/tpu_v1alpha1/classes.rb +68 -78
  318. data/generated/google/apis/tpu_v1alpha1/service.rb +21 -25
  319. data/generated/google/apis/translate_v3.rb +1 -1
  320. data/generated/google/apis/translate_v3/service.rb +14 -1
  321. data/generated/google/apis/translate_v3beta1.rb +1 -1
  322. data/generated/google/apis/translate_v3beta1/service.rb +14 -1
  323. data/generated/google/apis/vision_v1.rb +1 -1
  324. data/generated/google/apis/vision_v1/classes.rb +1304 -1870
  325. data/generated/google/apis/vision_v1/service.rb +254 -340
  326. data/generated/google/apis/vision_v1p1beta1.rb +1 -1
  327. data/generated/google/apis/vision_v1p1beta1/classes.rb +1246 -1790
  328. data/generated/google/apis/vision_v1p1beta1/service.rb +91 -121
  329. data/generated/google/apis/vision_v1p2beta1.rb +1 -1
  330. data/generated/google/apis/vision_v1p2beta1/classes.rb +1246 -1790
  331. data/generated/google/apis/vision_v1p2beta1/service.rb +91 -121
  332. data/generated/google/apis/websecurityscanner_v1.rb +1 -1
  333. data/generated/google/apis/websecurityscanner_v1/classes.rb +71 -95
  334. data/generated/google/apis/websecurityscanner_v1/service.rb +46 -65
  335. data/generated/google/apis/websecurityscanner_v1alpha.rb +1 -1
  336. data/generated/google/apis/websecurityscanner_v1alpha/classes.rb +55 -63
  337. data/generated/google/apis/websecurityscanner_v1alpha/service.rb +46 -65
  338. data/generated/google/apis/websecurityscanner_v1beta.rb +1 -1
  339. data/generated/google/apis/websecurityscanner_v1beta/classes.rb +77 -92
  340. data/generated/google/apis/websecurityscanner_v1beta/service.rb +46 -65
  341. data/generated/google/apis/youtube_analytics_v2.rb +1 -1
  342. data/generated/google/apis/youtube_analytics_v2/classes.rb +77 -104
  343. data/generated/google/apis/youtube_analytics_v2/service.rb +106 -126
  344. data/generated/google/apis/youtube_partner_v1.rb +1 -1
  345. data/generated/google/apis/youtube_partner_v1/service.rb +19 -19
  346. data/generated/google/apis/youtube_v3.rb +1 -1
  347. data/generated/google/apis/youtube_v3/classes.rb +937 -1175
  348. data/generated/google/apis/youtube_v3/service.rb +975 -1284
  349. data/generated/google/apis/youtubereporting_v1.rb +1 -1
  350. data/generated/google/apis/youtubereporting_v1/classes.rb +20 -29
  351. data/generated/google/apis/youtubereporting_v1/service.rb +40 -43
  352. data/lib/google/apis/core/base_service.rb +7 -1
  353. data/lib/google/apis/version.rb +1 -1
  354. metadata +15 -7
  355. data/generated/google/apis/fitness_v1.rb +0 -85
  356. data/generated/google/apis/fitness_v1/classes.rb +0 -1020
  357. data/generated/google/apis/fitness_v1/representations.rb +0 -398
  358. data/generated/google/apis/fitness_v1/service.rb +0 -647
@@ -48,9 +48,8 @@ module Google
48
48
  @batch_path = 'batch'
49
49
  end
50
50
 
51
- # Gets the latest state of a long-running operation. Clients can use this
52
- # method to poll the operation result at intervals as recommended by the API
53
- # service.
51
+ # Gets the latest state of a long-running operation. Clients can use this method
52
+ # to poll the operation result at intervals as recommended by the API service.
54
53
  # @param [String] name
55
54
  # The name of the operation resource.
56
55
  # @param [String] fields
@@ -80,23 +79,22 @@ module Google
80
79
  execute_or_queue_command(command, &block)
81
80
  end
82
81
 
83
- # For service producers, provisions a new subnet in a
84
- # peered service's shared VPC network in the requested region and with the
85
- # requested size that's expressed as a CIDR range (number of leading bits of
86
- # ipV4 network mask). The method checks against the assigned allocated ranges
87
- # to find a non-conflicting IP address range. The method will reuse a subnet
88
- # if subsequent calls contain the same subnet name, region, and prefix
89
- # length. This method will make producer's tenant project to be a shared VPC
90
- # service project as needed. The response from the `get` operation will be of
91
- # type `Subnetwork` if the operation successfully completes.
82
+ # For service producers, provisions a new subnet in a peered service's shared
83
+ # VPC network in the requested region and with the requested size that's
84
+ # expressed as a CIDR range (number of leading bits of ipV4 network mask). The
85
+ # method checks against the assigned allocated ranges to find a non-conflicting
86
+ # IP address range. The method will reuse a subnet if subsequent calls contain
87
+ # the same subnet name, region, and prefix length. This method will make
88
+ # producer's tenant project to be a shared VPC service project as needed. The
89
+ # response from the `get` operation will be of type `Subnetwork` if the
90
+ # operation successfully completes.
92
91
  # @param [String] parent
93
92
  # Required. A tenant project in the service producer organization, in the
94
- # following format: services/`service`/`collection-id`/`resource-id`.
95
- # `collection-id` is the cloud resource collection type that represents the
96
- # tenant project. Only `projects` are supported.
97
- # `resource-id` is the tenant project numeric id, such as
98
- # `123456`. `service` the name of the peering service, such as
99
- # `service-peering.example.com`. This service must already be
93
+ # following format: services/`service`/`collection-id`/`resource-id`. `
94
+ # collection-id` is the cloud resource collection type that represents the
95
+ # tenant project. Only `projects` are supported. `resource-id` is the tenant
96
+ # project numeric id, such as `123456`. `service` the name of the peering
97
+ # service, such as `service-peering.example.com`. This service must already be
100
98
  # enabled in the service consumer's project.
101
99
  # @param [Google::Apis::ServicenetworkingV1beta::AddSubnetworkRequest] add_subnetwork_request_object
102
100
  # @param [String] fields
@@ -128,18 +126,14 @@ module Google
128
126
  execute_or_queue_command(command, &block)
129
127
  end
130
128
 
131
- # Service producers can use this method to find a currently unused range
132
- # within consumer allocated ranges. This returned range is not reserved,
133
- # and not guaranteed to remain unused.
134
- # It will validate previously provided allocated ranges, find
135
- # non-conflicting sub-range of requested size (expressed in
136
- # number of leading bits of ipv4 network mask, as in CIDR range
137
- # notation).
138
- # Operation<response: Range>
129
+ # Service producers can use this method to find a currently unused range within
130
+ # consumer allocated ranges. This returned range is not reserved, and not
131
+ # guaranteed to remain unused. It will validate previously provided allocated
132
+ # ranges, find non-conflicting sub-range of requested size (expressed in number
133
+ # of leading bits of ipv4 network mask, as in CIDR range notation). Operation
139
134
  # @param [String] parent
140
- # Required. This is in a form services/`service`.
141
- # `service` the name of the private access management service, for example
142
- # 'service-peering.example.com'.
135
+ # Required. This is in a form services/`service`. `service` the name of the
136
+ # private access management service, for example 'service-peering.example.com'.
143
137
  # @param [Google::Apis::ServicenetworkingV1beta::SearchRangeRequest] search_range_request_object
144
138
  # @param [String] fields
145
139
  # Selector specifying which fields to include in a partial response.
@@ -170,21 +164,20 @@ module Google
170
164
  execute_or_queue_command(command, &block)
171
165
  end
172
166
 
173
- # Updates the allocated ranges that are assigned to a connection.
174
- # The response from the `get` operation will be of type `Connection` if the
175
- # operation successfully completes.
167
+ # Updates the allocated ranges that are assigned to a connection. The response
168
+ # from the `get` operation will be of type `Connection` if the operation
169
+ # successfully completes.
176
170
  # @param [String] name
177
- # The service producer peering service that is managing peering connectivity
178
- # for a service producer organization.
179
- # For Google services that support this functionality, this is
180
- # `services/servicenetworking.googleapis.com`.
171
+ # The service producer peering service that is managing peering connectivity for
172
+ # a service producer organization. For Google services that support this
173
+ # functionality, this is `services/servicenetworking.googleapis.com`.
181
174
  # @param [Google::Apis::ServicenetworkingV1beta::Connection] connection_object
182
175
  # @param [Boolean] force
183
- # If a previously defined allocated range is removed, force flag must be
184
- # set to true.
176
+ # If a previously defined allocated range is removed, force flag must be set to
177
+ # true.
185
178
  # @param [String] update_mask
186
- # The update mask. If this is omitted, it defaults to "*". You can only
187
- # update the listed peering ranges.
179
+ # The update mask. If this is omitted, it defaults to "*". You can only update
180
+ # the listed peering ranges.
188
181
  # @param [String] fields
189
182
  # Selector specifying which fields to include in a partial response.
190
183
  # @param [String] quota_user
@@ -216,19 +209,18 @@ module Google
216
209
  execute_or_queue_command(command, &block)
217
210
  end
218
211
 
219
- # Creates a private connection that establishes a VPC Network Peering
220
- # connection to a VPC network in the service producer's organization.
221
- # The administrator of the service consumer's VPC network invokes this
222
- # method. The administrator must assign one or more allocated IP ranges for
223
- # provisioning subnetworks in the service producer's VPC network. This
224
- # connection is used for all supported services in the service producer's
225
- # organization, so it only needs to be invoked once. The response from the
226
- # `get` operation will be of type `Connection` if the operation successfully
227
- # completes.
212
+ # Creates a private connection that establishes a VPC Network Peering connection
213
+ # to a VPC network in the service producer's organization. The administrator of
214
+ # the service consumer's VPC network invokes this method. The administrator must
215
+ # assign one or more allocated IP ranges for provisioning subnetworks in the
216
+ # service producer's VPC network. This connection is used for all supported
217
+ # services in the service producer's organization, so it only needs to be
218
+ # invoked once. The response from the `get` operation will be of type `
219
+ # Connection` if the operation successfully completes.
228
220
  # @param [String] parent
229
221
  # The service that is managing peering connectivity for a service producer's
230
- # organization. For Google services that support this functionality, this
231
- # value is `services/servicenetworking.googleapis.com`.
222
+ # organization. For Google services that support this functionality, this value
223
+ # is `services/servicenetworking.googleapis.com`.
232
224
  # @param [Google::Apis::ServicenetworkingV1beta::Connection] connection_object
233
225
  # @param [String] fields
234
226
  # Selector specifying which fields to include in a partial response.
@@ -259,22 +251,19 @@ module Google
259
251
  execute_or_queue_command(command, &block)
260
252
  end
261
253
 
262
- # List the private connections that are configured in a service consumer's
263
- # VPC network.
254
+ # List the private connections that are configured in a service consumer's VPC
255
+ # network.
264
256
  # @param [String] parent
265
257
  # The service that is managing peering connectivity for a service producer's
266
- # organization. For Google services that support this functionality, this
267
- # value is `services/servicenetworking.googleapis.com`.
268
- # If you specify `-` as the parameter value, all configured public peering
269
- # services are listed.
258
+ # organization. For Google services that support this functionality, this value
259
+ # is `services/servicenetworking.googleapis.com`. If you specify `-` as the
260
+ # parameter value, all configured public peering services are listed.
270
261
  # @param [String] network
271
262
  # The name of service consumer's VPC network that's connected with service
272
- # producer network through a private connection. The network name must be in
273
- # the following format:
274
- # `projects/`project`/global/networks/`network``. `project` is a
275
- # project number, such as in `12345` that includes the VPC service
276
- # consumer's VPC network. `network` is the name of the service consumer's VPC
277
- # network.
263
+ # producer network through a private connection. The network name must be in the
264
+ # following format: `projects/`project`/global/networks/`network``. `project` is
265
+ # a project number, such as in `12345` that includes the VPC service consumer's
266
+ # VPC network. `network` is the name of the service consumer's VPC network.
278
267
  # @param [String] fields
279
268
  # Selector specifying which fields to include in a partial response.
280
269
  # @param [String] quota_user
@@ -27,7 +27,7 @@ module Google
27
27
  # @see https://cloud.google.com/service-usage/
28
28
  module ServiceusageV1
29
29
  VERSION = 'V1'
30
- REVISION = '20200721'
30
+ REVISION = '20200801'
31
31
 
32
32
  # View and manage your data across Google Cloud Platform services
33
33
  AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
@@ -26,53 +26,48 @@ module Google
26
26
  class AdminQuotaPolicy
27
27
  include Google::Apis::Core::Hashable
28
28
 
29
- # The cloud resource container at which the quota policy is created. The
30
- # format is `container_type`/`container_number`
29
+ # The cloud resource container at which the quota policy is created. The format
30
+ # is `container_type`/`container_number`
31
31
  # Corresponds to the JSON property `container`
32
32
  # @return [String]
33
33
  attr_accessor :container
34
34
 
35
- # If this map is nonempty, then this policy applies only to specific values
36
- # for dimensions defined in the limit unit.
37
- # For example, an policy on a limit with the unit 1/`project`/`region`
38
- # could contain an entry with the key "region" and the value "us-east-1";
39
- # the policy is only applied to quota consumed in that region.
40
- # This map has the following restrictions:
41
- # * If "region" appears as a key, its value must be a valid Cloud region.
42
- # * If "zone" appears as a key, its value must be a valid Cloud zone.
43
- # * Keys other than "region" or "zone" are not valid.
35
+ # If this map is nonempty, then this policy applies only to specific values for
36
+ # dimensions defined in the limit unit. For example, an policy on a limit with
37
+ # the unit 1/`project`/`region` could contain an entry with the key "region" and
38
+ # the value "us-east-1"; the policy is only applied to quota consumed in that
39
+ # region. This map has the following restrictions: * If "region" appears as a
40
+ # key, its value must be a valid Cloud region. * If "zone" appears as a key, its
41
+ # value must be a valid Cloud zone. * Keys other than "region" or "zone" are not
42
+ # valid.
44
43
  # Corresponds to the JSON property `dimensions`
45
44
  # @return [Hash<String,String>]
46
45
  attr_accessor :dimensions
47
46
 
48
- # The name of the metric to which this policy applies.
49
- # An example name would be:
47
+ # The name of the metric to which this policy applies. An example name would be:
50
48
  # `compute.googleapis.com/cpus`
51
49
  # Corresponds to the JSON property `metric`
52
50
  # @return [String]
53
51
  attr_accessor :metric
54
52
 
55
- # The resource name of the policy.
56
- # This name is generated by the server when the policy is created.
57
- # Example names would be:
58
- # `organizations/123/services/compute.googleapis.com/consumerQuotaMetrics/
59
- # compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/adminQuotaPolicies/
60
- # 4a3f2c1d`
53
+ # The resource name of the policy. This name is generated by the server when the
54
+ # policy is created. Example names would be: `organizations/123/services/compute.
55
+ # googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%
56
+ # 2Fproject%2Fregion/adminQuotaPolicies/4a3f2c1d`
61
57
  # Corresponds to the JSON property `name`
62
58
  # @return [String]
63
59
  attr_accessor :name
64
60
 
65
- # The quota policy value.
66
- # Can be any nonnegative integer, or -1 (unlimited quota).
61
+ # The quota policy value. Can be any nonnegative integer, or -1 (unlimited quota)
62
+ # .
67
63
  # Corresponds to the JSON property `policyValue`
68
64
  # @return [Fixnum]
69
65
  attr_accessor :policy_value
70
66
 
71
- # The limit unit of the limit to which this policy applies.
72
- # An example unit would be:
73
- # `1/`project`/`region``
74
- # Note that ``project`` and ``region`` are not placeholders in this example;
75
- # the literal characters ``` and ``` occur in the string.
67
+ # The limit unit of the limit to which this policy applies. An example unit
68
+ # would be: `1/`project`/`region`` Note that ``project`` and ``region`` are not
69
+ # placeholders in this example; the literal characters ``` and ``` occur in the
70
+ # string.
76
71
  # Corresponds to the JSON property `unit`
77
72
  # @return [String]
78
73
  attr_accessor :unit
@@ -92,14 +87,13 @@ module Google
92
87
  end
93
88
  end
94
89
 
95
- # Api is a light-weight descriptor for an API Interface.
96
- # Interfaces are also described as "protocol buffer services" in some contexts,
97
- # such as by the "service" keyword in a .proto file, but they are different
98
- # from API Services, which represent a concrete implementation of an interface
99
- # as opposed to simply a description of methods and bindings. They are also
100
- # sometimes simply referred to as "APIs" in other contexts, such as the name of
101
- # this message itself. See https://cloud.google.com/apis/design/glossary for
102
- # detailed terminology.
90
+ # Api is a light-weight descriptor for an API Interface. Interfaces are also
91
+ # described as "protocol buffer services" in some contexts, such as by the "
92
+ # service" keyword in a .proto file, but they are different from API Services,
93
+ # which represent a concrete implementation of an interface as opposed to simply
94
+ # a description of methods and bindings. They are also sometimes simply referred
95
+ # to as "APIs" in other contexts, such as the name of this message itself. See
96
+ # https://cloud.google.com/apis/design/glossary for detailed terminology.
103
97
  class Api
104
98
  include Google::Apis::Core::Hashable
105
99
 
@@ -113,8 +107,8 @@ module Google
113
107
  # @return [Array<Google::Apis::ServiceusageV1::Mixin>]
114
108
  attr_accessor :mixins
115
109
 
116
- # The fully qualified name of this interface, including package name
117
- # followed by the interface's simple name.
110
+ # The fully qualified name of this interface, including package name followed by
111
+ # the interface's simple name.
118
112
  # Corresponds to the JSON property `name`
119
113
  # @return [String]
120
114
  attr_accessor :name
@@ -124,8 +118,8 @@ module Google
124
118
  # @return [Array<Google::Apis::ServiceusageV1::Option>]
125
119
  attr_accessor :options
126
120
 
127
- # `SourceContext` represents information about the source of a
128
- # protobuf element, like the file in which it is defined.
121
+ # `SourceContext` represents information about the source of a protobuf element,
122
+ # like the file in which it is defined.
129
123
  # Corresponds to the JSON property `sourceContext`
130
124
  # @return [Google::Apis::ServiceusageV1::SourceContext]
131
125
  attr_accessor :source_context
@@ -135,23 +129,19 @@ module Google
135
129
  # @return [String]
136
130
  attr_accessor :syntax
137
131
 
138
- # A version string for this interface. If specified, must have the form
139
- # `major-version.minor-version`, as in `1.10`. If the minor version is
140
- # omitted, it defaults to zero. If the entire version field is empty, the
141
- # major version is derived from the package name, as outlined below. If the
142
- # field is not empty, the version in the package name will be verified to be
143
- # consistent with what is provided here.
144
- # The versioning schema uses [semantic
145
- # versioning](http://semver.org) where the major version number
146
- # indicates a breaking change and the minor version an additive,
147
- # non-breaking change. Both version numbers are signals to users
148
- # what to expect from different versions, and should be carefully
149
- # chosen based on the product plan.
150
- # The major version is also reflected in the package name of the
151
- # interface, which must end in `v<major-version>`, as in
152
- # `google.feature.v1`. For major versions 0 and 1, the suffix can
153
- # be omitted. Zero major versions must only be used for
154
- # experimental, non-GA interfaces.
132
+ # A version string for this interface. If specified, must have the form `major-
133
+ # version.minor-version`, as in `1.10`. If the minor version is omitted, it
134
+ # defaults to zero. If the entire version field is empty, the major version is
135
+ # derived from the package name, as outlined below. If the field is not empty,
136
+ # the version in the package name will be verified to be consistent with what is
137
+ # provided here. The versioning schema uses [semantic versioning](http://semver.
138
+ # org) where the major version number indicates a breaking change and the minor
139
+ # version an additive, non-breaking change. Both version numbers are signals to
140
+ # users what to expect from different versions, and should be carefully chosen
141
+ # based on the product plan. The major version is also reflected in the package
142
+ # name of the interface, which must end in `v`, as in `google.feature.v1`. For
143
+ # major versions 0 and 1, the suffix can be omitted. Zero major versions must
144
+ # only be used for experimental, non-GA interfaces.
155
145
  # Corresponds to the JSON property `version`
156
146
  # @return [String]
157
147
  attr_accessor :version
@@ -172,85 +162,63 @@ module Google
172
162
  end
173
163
  end
174
164
 
175
- # Configuration for an authentication provider, including support for
176
- # [JSON Web Token
177
- # (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).
165
+ # Configuration for an authentication provider, including support for [JSON Web
166
+ # Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).
178
167
  class AuthProvider
179
168
  include Google::Apis::Core::Hashable
180
169
 
181
- # The list of JWT
182
- # [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#
183
- # section-4.1.3).
184
- # that are allowed to access. A JWT containing any of these audiences will
185
- # be accepted. When this setting is absent, JWTs with audiences:
186
- # - "https://[service.name]/[google.protobuf.Api.name]"
187
- # - "https://[service.name]/"
188
- # will be accepted.
189
- # For example, if no audiences are in the setting, LibraryService API will
190
- # accept JWTs with the following audiences:
191
- # -
170
+ # The list of JWT [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-
171
+ # web-token-32#section-4.1.3). that are allowed to access. A JWT containing any
172
+ # of these audiences will be accepted. When this setting is absent, JWTs with
173
+ # audiences: - "https://[service.name]/[google.protobuf.Api.name]" - "https://[
174
+ # service.name]/" will be accepted. For example, if no audiences are in the
175
+ # setting, LibraryService API will accept JWTs with the following audiences: -
192
176
  # https://library-example.googleapis.com/google.example.library.v1.
193
- # LibraryService
194
- # - https://library-example.googleapis.com/
195
- # Example:
196
- # audiences: bookstore_android.apps.googleusercontent.com,
197
- # bookstore_web.apps.googleusercontent.com
177
+ # LibraryService - https://library-example.googleapis.com/ Example: audiences:
178
+ # bookstore_android.apps.googleusercontent.com, bookstore_web.apps.
179
+ # googleusercontent.com
198
180
  # Corresponds to the JSON property `audiences`
199
181
  # @return [String]
200
182
  attr_accessor :audiences
201
183
 
202
- # Redirect URL if JWT token is required but not present or is expired.
203
- # Implement authorizationUrl of securityDefinitions in OpenAPI spec.
184
+ # Redirect URL if JWT token is required but not present or is expired. Implement
185
+ # authorizationUrl of securityDefinitions in OpenAPI spec.
204
186
  # Corresponds to the JSON property `authorizationUrl`
205
187
  # @return [String]
206
188
  attr_accessor :authorization_url
207
189
 
208
- # The unique identifier of the auth provider. It will be referred to by
209
- # `AuthRequirement.provider_id`.
210
- # Example: "bookstore_auth".
190
+ # The unique identifier of the auth provider. It will be referred to by `
191
+ # AuthRequirement.provider_id`. Example: "bookstore_auth".
211
192
  # Corresponds to the JSON property `id`
212
193
  # @return [String]
213
194
  attr_accessor :id
214
195
 
215
- # Identifies the principal that issued the JWT. See
216
- # https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1
217
- # Usually a URL or an email address.
218
- # Example: https://securetoken.google.com
219
- # Example: 1234567-compute@developer.gserviceaccount.com
196
+ # Identifies the principal that issued the JWT. See https://tools.ietf.org/html/
197
+ # draft-ietf-oauth-json-web-token-32#section-4.1.1 Usually a URL or an email
198
+ # address. Example: https://securetoken.google.com Example: 1234567-compute@
199
+ # developer.gserviceaccount.com
220
200
  # Corresponds to the JSON property `issuer`
221
201
  # @return [String]
222
202
  attr_accessor :issuer
223
203
 
224
- # URL of the provider's public key set to validate signature of the JWT. See
225
- # [OpenID
226
- # Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#
227
- # ProviderMetadata).
228
- # Optional if the key set document:
229
- # - can be retrieved from
230
- # [OpenID
231
- # Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html of
232
- # the issuer.
233
- # - can be inferred from the email domain of the issuer (e.g. a Google
234
- # service account).
235
- # Example: https://www.googleapis.com/oauth2/v1/certs
204
+ # URL of the provider's public key set to validate signature of the JWT. See [
205
+ # OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#
206
+ # ProviderMetadata). Optional if the key set document: - can be retrieved from [
207
+ # OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html
208
+ # of the issuer. - can be inferred from the email domain of the issuer (e.g. a
209
+ # Google service account). Example: https://www.googleapis.com/oauth2/v1/certs
236
210
  # Corresponds to the JSON property `jwksUri`
237
211
  # @return [String]
238
212
  attr_accessor :jwks_uri
239
213
 
240
- # Defines the locations to extract the JWT.
241
- # JWT locations can be either from HTTP headers or URL query parameters.
242
- # The rule is that the first match wins. The checking order is: checking
243
- # all headers first, then URL query parameters.
244
- # If not specified, default to use following 3 locations:
245
- # 1) Authorization: Bearer
246
- # 2) x-goog-iap-jwt-assertion
247
- # 3) access_token query parameter
248
- # Default locations can be specified as followings:
249
- # jwt_locations:
250
- # - header: Authorization
251
- # value_prefix: "Bearer "
252
- # - header: x-goog-iap-jwt-assertion
253
- # - query: access_token
214
+ # Defines the locations to extract the JWT. JWT locations can be either from
215
+ # HTTP headers or URL query parameters. The rule is that the first match wins.
216
+ # The checking order is: checking all headers first, then URL query parameters.
217
+ # If not specified, default to use following 3 locations: 1) Authorization:
218
+ # Bearer 2) x-goog-iap-jwt-assertion 3) access_token query parameter Default
219
+ # locations can be specified as followings: jwt_locations: - header:
220
+ # Authorization value_prefix: "Bearer " - header: x-goog-iap-jwt-assertion -
221
+ # query: access_token
254
222
  # Corresponds to the JSON property `jwtLocations`
255
223
  # @return [Array<Google::Apis::ServiceusageV1::JwtLocation>]
256
224
  attr_accessor :jwt_locations
@@ -270,34 +238,26 @@ module Google
270
238
  end
271
239
  end
272
240
 
273
- # User-defined authentication requirements, including support for
274
- # [JSON Web Token
275
- # (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).
241
+ # User-defined authentication requirements, including support for [JSON Web
242
+ # Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).
276
243
  class AuthRequirement
277
244
  include Google::Apis::Core::Hashable
278
245
 
279
- # NOTE: This will be deprecated soon, once AuthProvider.audiences is
280
- # implemented and accepted in all the runtime components.
281
- # The list of JWT
282
- # [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#
283
- # section-4.1.3).
284
- # that are allowed to access. A JWT containing any of these audiences will
285
- # be accepted. When this setting is absent, only JWTs with audience
286
- # "https://Service_name/API_name"
287
- # will be accepted. For example, if no audiences are in the setting,
288
- # LibraryService API will only accept JWTs with the following audience
289
- # "https://library-example.googleapis.com/google.example.library.v1.
290
- # LibraryService".
291
- # Example:
292
- # audiences: bookstore_android.apps.googleusercontent.com,
293
- # bookstore_web.apps.googleusercontent.com
246
+ # NOTE: This will be deprecated soon, once AuthProvider.audiences is implemented
247
+ # and accepted in all the runtime components. The list of JWT [audiences](https:/
248
+ # /tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). that
249
+ # are allowed to access. A JWT containing any of these audiences will be
250
+ # accepted. When this setting is absent, only JWTs with audience "https://
251
+ # Service_name/API_name" will be accepted. For example, if no audiences are in
252
+ # the setting, LibraryService API will only accept JWTs with the following
253
+ # audience "https://library-example.googleapis.com/google.example.library.v1.
254
+ # LibraryService". Example: audiences: bookstore_android.apps.googleusercontent.
255
+ # com, bookstore_web.apps.googleusercontent.com
294
256
  # Corresponds to the JSON property `audiences`
295
257
  # @return [String]
296
258
  attr_accessor :audiences
297
259
 
298
- # id from authentication provider.
299
- # Example:
300
- # provider_id: bookstore_auth
260
+ # id from authentication provider. Example: provider_id: bookstore_auth
301
261
  # Corresponds to the JSON property `providerId`
302
262
  # @return [String]
303
263
  attr_accessor :provider_id
@@ -313,18 +273,11 @@ module Google
313
273
  end
314
274
  end
315
275
 
316
- # `Authentication` defines the authentication configuration for an API.
317
- # Example for an API targeted for external use:
318
- # name: calendar.googleapis.com
319
- # authentication:
320
- # providers:
321
- # - id: google_calendar_auth
322
- # jwks_uri: https://www.googleapis.com/oauth2/v1/certs
323
- # issuer: https://securetoken.google.com
324
- # rules:
325
- # - selector: "*"
326
- # requirements:
327
- # provider_id: google_calendar_auth
276
+ # `Authentication` defines the authentication configuration for an API. Example
277
+ # for an API targeted for external use: name: calendar.googleapis.com
278
+ # authentication: providers: - id: google_calendar_auth jwks_uri: https://www.
279
+ # googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: -
280
+ # selector: "*" requirements: provider_id: google_calendar_auth
328
281
  class Authentication
329
282
  include Google::Apis::Core::Hashable
330
283
 
@@ -333,8 +286,8 @@ module Google
333
286
  # @return [Array<Google::Apis::ServiceusageV1::AuthProvider>]
334
287
  attr_accessor :providers
335
288
 
336
- # A list of authentication rules that apply to individual API methods.
337
- # **NOTE:** All service configuration rules follow "last one wins" order.
289
+ # A list of authentication rules that apply to individual API methods. **NOTE:**
290
+ # All service configuration rules follow "last one wins" order.
338
291
  # Corresponds to the JSON property `rules`
339
292
  # @return [Array<Google::Apis::ServiceusageV1::AuthenticationRule>]
340
293
  attr_accessor :rules
@@ -350,13 +303,11 @@ module Google
350
303
  end
351
304
  end
352
305
 
353
- # Authentication rules for the service.
354
- # By default, if a method has any authentication requirements, every request
355
- # must include a valid credential matching one of the requirements.
356
- # It's an error to include more than one kind of credential in a single
357
- # request.
358
- # If a method doesn't have any auth requirements, request credentials will be
359
- # ignored.
306
+ # Authentication rules for the service. By default, if a method has any
307
+ # authentication requirements, every request must include a valid credential
308
+ # matching one of the requirements. It's an error to include more than one kind
309
+ # of credential in a single request. If a method doesn't have any auth
310
+ # requirements, request credentials will be ignored.
360
311
  class AuthenticationRule
361
312
  include Google::Apis::Core::Hashable
362
313
 
@@ -367,19 +318,18 @@ module Google
367
318
  alias_method :allow_without_credential?, :allow_without_credential
368
319
 
369
320
  # OAuth scopes are a way to define data and permissions on data. For example,
370
- # there are scopes defined for "Read-only access to Google Calendar" and
371
- # "Access to Cloud Platform". Users can consent to a scope for an application,
372
- # giving it permission to access that data on their behalf.
373
- # OAuth scope specifications should be fairly coarse grained; a user will need
374
- # to see and understand the text description of what your scope means.
375
- # In most cases: use one or at most two OAuth scopes for an entire family of
376
- # products. If your product has multiple APIs, you should probably be sharing
377
- # the OAuth scope across all of those APIs.
378
- # When you need finer grained OAuth consent screens: talk with your product
379
- # management about how developers will use them in practice.
380
- # Please note that even though each of the canonical scopes is enough for a
381
- # request to be accepted and passed to the backend, a request can still fail
382
- # due to the backend requiring additional scopes or permissions.
321
+ # there are scopes defined for "Read-only access to Google Calendar" and "Access
322
+ # to Cloud Platform". Users can consent to a scope for an application, giving it
323
+ # permission to access that data on their behalf. OAuth scope specifications
324
+ # should be fairly coarse grained; a user will need to see and understand the
325
+ # text description of what your scope means. In most cases: use one or at most
326
+ # two OAuth scopes for an entire family of products. If your product has
327
+ # multiple APIs, you should probably be sharing the OAuth scope across all of
328
+ # those APIs. When you need finer grained OAuth consent screens: talk with your
329
+ # product management about how developers will use them in practice. Please note
330
+ # that even though each of the canonical scopes is enough for a request to be
331
+ # accepted and passed to the backend, a request can still fail due to the
332
+ # backend requiring additional scopes or permissions.
383
333
  # Corresponds to the JSON property `oauth`
384
334
  # @return [Google::Apis::ServiceusageV1::OAuthRequirements]
385
335
  attr_accessor :oauth
@@ -389,8 +339,8 @@ module Google
389
339
  # @return [Array<Google::Apis::ServiceusageV1::AuthRequirement>]
390
340
  attr_accessor :requirements
391
341
 
392
- # Selects the methods to which this rule applies.
393
- # Refer to selector for syntax details.
342
+ # Selects the methods to which this rule applies. Refer to selector for syntax
343
+ # details.
394
344
  # Corresponds to the JSON property `selector`
395
345
  # @return [String]
396
346
  attr_accessor :selector
@@ -412,8 +362,8 @@ module Google
412
362
  class Backend
413
363
  include Google::Apis::Core::Hashable
414
364
 
415
- # A list of API backend rules that apply to individual API methods.
416
- # **NOTE:** All service configuration rules follow "last one wins" order.
365
+ # A list of API backend rules that apply to individual API methods. **NOTE:**
366
+ # All service configuration rules follow "last one wins" order.
417
367
  # Corresponds to the JSON property `rules`
418
368
  # @return [Array<Google::Apis::ServiceusageV1::BackendRule>]
419
369
  attr_accessor :rules
@@ -432,21 +382,13 @@ module Google
432
382
  class BackendRule
433
383
  include Google::Apis::Core::Hashable
434
384
 
435
- # The address of the API backend.
436
- # The scheme is used to determine the backend protocol and security.
437
- # The following schemes are accepted:
438
- # SCHEME PROTOCOL SECURITY
439
- # http:// HTTP None
440
- # https:// HTTP TLS
441
- # grpc:// gRPC None
442
- # grpcs:// gRPC TLS
443
- # It is recommended to explicitly include a scheme. Leaving out the scheme
444
- # may cause constrasting behaviors across platforms.
445
- # If the port is unspecified, the default is:
446
- # - 80 for schemes without TLS
447
- # - 443 for schemes with TLS
448
- # For HTTP backends, use protocol
449
- # to specify the protocol version.
385
+ # The address of the API backend. The scheme is used to determine the backend
386
+ # protocol and security. The following schemes are accepted: SCHEME PROTOCOL
387
+ # SECURITY http:// HTTP None https:// HTTP TLS grpc:// gRPC None grpcs:// gRPC
388
+ # TLS It is recommended to explicitly include a scheme. Leaving out the scheme
389
+ # may cause constrasting behaviors across platforms. If the port is unspecified,
390
+ # the default is: - 80 for schemes without TLS - 443 for schemes with TLS For
391
+ # HTTP backends, use protocol to specify the protocol version.
450
392
  # Corresponds to the JSON property `address`
451
393
  # @return [String]
452
394
  attr_accessor :address
@@ -457,18 +399,18 @@ module Google
457
399
  # @return [Float]
458
400
  attr_accessor :deadline
459
401
 
460
- # When disable_auth is true, a JWT ID token won't be generated and the
461
- # original "Authorization" HTTP header will be preserved. If the header is
462
- # used to carry the original token and is expected by the backend, this
463
- # field must be set to true to preserve the header.
402
+ # When disable_auth is true, a JWT ID token won't be generated and the original "
403
+ # Authorization" HTTP header will be preserved. If the header is used to carry
404
+ # the original token and is expected by the backend, this field must be set to
405
+ # true to preserve the header.
464
406
  # Corresponds to the JSON property `disableAuth`
465
407
  # @return [Boolean]
466
408
  attr_accessor :disable_auth
467
409
  alias_method :disable_auth?, :disable_auth
468
410
 
469
- # The JWT audience is used when generating a JWT ID token for the backend.
470
- # This ID token will be added in the HTTP "authorization" header, and sent
471
- # to the backend.
411
+ # The JWT audience is used when generating a JWT ID token for the backend. This
412
+ # ID token will be added in the HTTP "authorization" header, and sent to the
413
+ # backend.
472
414
  # Corresponds to the JSON property `jwtAudience`
473
415
  # @return [String]
474
416
  attr_accessor :jwt_audience
@@ -479,8 +421,8 @@ module Google
479
421
  # @return [Float]
480
422
  attr_accessor :min_deadline
481
423
 
482
- # The number of seconds to wait for the completion of a long running
483
- # operation. The default is no deadline.
424
+ # The number of seconds to wait for the completion of a long running operation.
425
+ # The default is no deadline.
484
426
  # Corresponds to the JSON property `operationDeadline`
485
427
  # @return [Float]
486
428
  attr_accessor :operation_deadline
@@ -490,29 +432,21 @@ module Google
490
432
  # @return [String]
491
433
  attr_accessor :path_translation
492
434
 
493
- # The protocol used for sending a request to the backend.
494
- # The supported values are "http/1.1" and "h2".
495
- # The default value is inferred from the scheme in the
496
- # address field:
497
- # SCHEME PROTOCOL
498
- # http:// http/1.1
499
- # https:// http/1.1
500
- # grpc:// h2
501
- # grpcs:// h2
502
- # For secure HTTP backends (https://) that support HTTP/2, set this field
503
- # to "h2" for improved performance.
504
- # Configuring this field to non-default values is only supported for secure
505
- # HTTP backends. This field will be ignored for all other backends.
506
- # See
507
- # https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-
508
- # values.xhtml#alpn-protocol-ids
509
- # for more details on the supported values.
435
+ # The protocol used for sending a request to the backend. The supported values
436
+ # are "http/1.1" and "h2". The default value is inferred from the scheme in the
437
+ # address field: SCHEME PROTOCOL http:// http/1.1 https:// http/1.1 grpc:// h2
438
+ # grpcs:// h2 For secure HTTP backends (https://) that support HTTP/2, set this
439
+ # field to "h2" for improved performance. Configuring this field to non-default
440
+ # values is only supported for secure HTTP backends. This field will be ignored
441
+ # for all other backends. See https://www.iana.org/assignments/tls-extensiontype-
442
+ # values/tls-extensiontype-values.xhtml#alpn-protocol-ids for more details on
443
+ # the supported values.
510
444
  # Corresponds to the JSON property `protocol`
511
445
  # @return [String]
512
446
  attr_accessor :protocol
513
447
 
514
- # Selects the methods to which this rule applies.
515
- # Refer to selector for syntax details.
448
+ # Selects the methods to which this rule applies. Refer to selector for syntax
449
+ # details.
516
450
  # Corresponds to the JSON property `selector`
517
451
  # @return [String]
518
452
  attr_accessor :selector
@@ -577,14 +511,11 @@ module Google
577
511
  class BatchEnableServicesRequest
578
512
  include Google::Apis::Core::Hashable
579
513
 
580
- # The identifiers of the services to enable on the project.
581
- # A valid identifier would be:
582
- # serviceusage.googleapis.com
583
- # Enabling services requires that each service is public or is shared with
584
- # the user enabling the service.
585
- # A single request can enable a maximum of 20 services at a time. If more
586
- # than 20 services are specified, the request will fail, and no state changes
587
- # will occur.
514
+ # The identifiers of the services to enable on the project. A valid identifier
515
+ # would be: serviceusage.googleapis.com Enabling services requires that each
516
+ # service is public or is shared with the user enabling the service. A single
517
+ # request can enable a maximum of 20 services at a time. If more than 20
518
+ # services are specified, the request will fail, and no state changes will occur.
588
519
  # Corresponds to the JSON property `serviceIds`
589
520
  # @return [Array<String>]
590
521
  attr_accessor :service_ids
@@ -599,9 +530,9 @@ module Google
599
530
  end
600
531
  end
601
532
 
602
- # Response message for the `BatchEnableServices` method.
603
- # This response message is assigned to the `response` field of the returned
604
- # Operation when that operation is done.
533
+ # Response message for the `BatchEnableServices` method. This response message
534
+ # is assigned to the `response` field of the returned Operation when that
535
+ # operation is done.
605
536
  class BatchEnableServicesResponse
606
537
  include Google::Apis::Core::Hashable
607
538
 
@@ -646,42 +577,28 @@ module Google
646
577
  end
647
578
  end
648
579
 
649
- # Billing related configuration of the service.
650
- # The following example shows how to configure monitored resources and metrics
651
- # for billing, `consumer_destinations` is the only supported destination and
652
- # the monitored resources need at least one label key
653
- # `cloud.googleapis.com/location` to indicate the location of the billing
654
- # usage, using different monitored resources between monitoring and billing is
655
- # recommended so they can be evolved independently:
656
- # monitored_resources:
657
- # - type: library.googleapis.com/billing_branch
658
- # labels:
659
- # - key: cloud.googleapis.com/location
660
- # description: |
661
- # Predefined label to support billing location restriction.
662
- # - key: city
663
- # description: |
664
- # Custom label to define the city where the library branch is located
665
- # in.
666
- # - key: name
667
- # description: Custom label to define the name of the library branch.
668
- # metrics:
669
- # - name: library.googleapis.com/book/borrowed_count
670
- # metric_kind: DELTA
671
- # value_type: INT64
672
- # unit: "1"
673
- # billing:
674
- # consumer_destinations:
675
- # - monitored_resource: library.googleapis.com/billing_branch
676
- # metrics:
677
- # - library.googleapis.com/book/borrowed_count
580
+ # Billing related configuration of the service. The following example shows how
581
+ # to configure monitored resources and metrics for billing, `
582
+ # consumer_destinations` is the only supported destination and the monitored
583
+ # resources need at least one label key `cloud.googleapis.com/location` to
584
+ # indicate the location of the billing usage, using different monitored
585
+ # resources between monitoring and billing is recommended so they can be evolved
586
+ # independently: monitored_resources: - type: library.googleapis.com/
587
+ # billing_branch labels: - key: cloud.googleapis.com/location description: |
588
+ # Predefined label to support billing location restriction. - key: city
589
+ # description: | Custom label to define the city where the library branch is
590
+ # located in. - key: name description: Custom label to define the name of the
591
+ # library branch. metrics: - name: library.googleapis.com/book/borrowed_count
592
+ # metric_kind: DELTA value_type: INT64 unit: "1" billing: consumer_destinations:
593
+ # - monitored_resource: library.googleapis.com/billing_branch metrics: - library.
594
+ # googleapis.com/book/borrowed_count
678
595
  class Billing
679
596
  include Google::Apis::Core::Hashable
680
597
 
681
- # Billing configurations for sending metrics to the consumer project.
682
- # There can be multiple consumer destinations per service, each one must have
683
- # a different monitored resource type. A metric can be used in at most
684
- # one consumer destination.
598
+ # Billing configurations for sending metrics to the consumer project. There can
599
+ # be multiple consumer destinations per service, each one must have a different
600
+ # monitored resource type. A metric can be used in at most one consumer
601
+ # destination.
685
602
  # Corresponds to the JSON property `consumerDestinations`
686
603
  # @return [Array<Google::Apis::ServiceusageV1::BillingDestination>]
687
604
  attr_accessor :consumer_destinations
@@ -696,19 +613,19 @@ module Google
696
613
  end
697
614
  end
698
615
 
699
- # Configuration of a specific billing destination (Currently only support
700
- # bill against consumer project).
616
+ # Configuration of a specific billing destination (Currently only support bill
617
+ # against consumer project).
701
618
  class BillingDestination
702
619
  include Google::Apis::Core::Hashable
703
620
 
704
- # Names of the metrics to report to this billing destination.
705
- # Each name must be defined in Service.metrics section.
621
+ # Names of the metrics to report to this billing destination. Each name must be
622
+ # defined in Service.metrics section.
706
623
  # Corresponds to the JSON property `metrics`
707
624
  # @return [Array<String>]
708
625
  attr_accessor :metrics
709
626
 
710
- # The monitored resource type. The type must be defined in
711
- # Service.monitored_resources section.
627
+ # The monitored resource type. The type must be defined in Service.
628
+ # monitored_resources section.
712
629
  # Corresponds to the JSON property `monitoredResource`
713
630
  # @return [String]
714
631
  attr_accessor :monitored_resource
@@ -737,39 +654,24 @@ module Google
737
654
  end
738
655
  end
739
656
 
740
- # `Context` defines which contexts an API requests.
741
- # Example:
742
- # context:
743
- # rules:
744
- # - selector: "*"
745
- # requested:
746
- # - google.rpc.context.ProjectContext
747
- # - google.rpc.context.OriginContext
748
- # The above specifies that all methods in the API request
749
- # `google.rpc.context.ProjectContext` and
750
- # `google.rpc.context.OriginContext`.
751
- # Available context types are defined in package
752
- # `google.rpc.context`.
753
- # This also provides mechanism to whitelist any protobuf message extension that
754
- # can be sent in grpc metadata using “x-goog-ext-<extension_id>-bin” and
755
- # “x-goog-ext-<extension_id>-jspb” format. For example, list any service
756
- # specific protobuf types that can appear in grpc metadata as follows in your
757
- # yaml file:
758
- # Example:
759
- # context:
760
- # rules:
761
- # - selector: "google.example.library.v1.LibraryService.CreateBook"
762
- # allowed_request_extensions:
763
- # - google.foo.v1.NewExtension
764
- # allowed_response_extensions:
765
- # - google.foo.v1.NewExtension
766
- # You can also specify extension ID instead of fully qualified extension name
767
- # here.
657
+ # `Context` defines which contexts an API requests. Example: context: rules: -
658
+ # selector: "*" requested: - google.rpc.context.ProjectContext - google.rpc.
659
+ # context.OriginContext The above specifies that all methods in the API request `
660
+ # google.rpc.context.ProjectContext` and `google.rpc.context.OriginContext`.
661
+ # Available context types are defined in package `google.rpc.context`. This also
662
+ # provides mechanism to whitelist any protobuf message extension that can be
663
+ # sent in grpc metadata using “x-goog-ext--bin” and “x-goog-ext--jspb” format.
664
+ # For example, list any service specific protobuf types that can appear in grpc
665
+ # metadata as follows in your yaml file: Example: context: rules: - selector: "
666
+ # google.example.library.v1.LibraryService.CreateBook"
667
+ # allowed_request_extensions: - google.foo.v1.NewExtension
668
+ # allowed_response_extensions: - google.foo.v1.NewExtension You can also specify
669
+ # extension ID instead of fully qualified extension name here.
768
670
  class Context
769
671
  include Google::Apis::Core::Hashable
770
672
 
771
- # A list of RPC context rules that apply to individual API methods.
772
- # **NOTE:** All service configuration rules follow "last one wins" order.
673
+ # A list of RPC context rules that apply to individual API methods. **NOTE:**
674
+ # All service configuration rules follow "last one wins" order.
773
675
  # Corresponds to the JSON property `rules`
774
676
  # @return [Array<Google::Apis::ServiceusageV1::ContextRule>]
775
677
  attr_accessor :rules
@@ -789,14 +691,14 @@ module Google
789
691
  class ContextRule
790
692
  include Google::Apis::Core::Hashable
791
693
 
792
- # A list of full type names or extension IDs of extensions allowed in grpc
793
- # side channel from client to backend.
694
+ # A list of full type names or extension IDs of extensions allowed in grpc side
695
+ # channel from client to backend.
794
696
  # Corresponds to the JSON property `allowedRequestExtensions`
795
697
  # @return [Array<String>]
796
698
  attr_accessor :allowed_request_extensions
797
699
 
798
- # A list of full type names or extension IDs of extensions allowed in grpc
799
- # side channel from backend to client.
700
+ # A list of full type names or extension IDs of extensions allowed in grpc side
701
+ # channel from backend to client.
800
702
  # Corresponds to the JSON property `allowedResponseExtensions`
801
703
  # @return [Array<String>]
802
704
  attr_accessor :allowed_response_extensions
@@ -811,8 +713,8 @@ module Google
811
713
  # @return [Array<String>]
812
714
  attr_accessor :requested
813
715
 
814
- # Selects the methods to which this rule applies.
815
- # Refer to selector for syntax details.
716
+ # Selects the methods to which this rule applies. Refer to selector for syntax
717
+ # details.
816
718
  # Corresponds to the JSON property `selector`
817
719
  # @return [String]
818
720
  attr_accessor :selector
@@ -831,14 +733,14 @@ module Google
831
733
  end
832
734
  end
833
735
 
834
- # Selects and configures the service controller used by the service. The
835
- # service controller handles features like abuse, quota, billing, logging,
836
- # monitoring, etc.
736
+ # Selects and configures the service controller used by the service. The service
737
+ # controller handles features like abuse, quota, billing, logging, monitoring,
738
+ # etc.
837
739
  class Control
838
740
  include Google::Apis::Core::Hashable
839
741
 
840
- # The service control environment to use. If empty, no control plane
841
- # feature (like quota and billing) will be enabled.
742
+ # The service control environment to use. If empty, no control plane feature (
743
+ # like quota and billing) will be enabled.
842
744
  # Corresponds to the JSON property `environment`
843
745
  # @return [String]
844
746
  attr_accessor :environment
@@ -853,19 +755,15 @@ module Google
853
755
  end
854
756
  end
855
757
 
856
- # Customize service error responses. For example, list any service
857
- # specific protobuf types that can appear in error detail lists of
858
- # error responses.
859
- # Example:
860
- # custom_error:
861
- # types:
862
- # - google.foo.v1.CustomError
863
- # - google.foo.v1.AnotherError
758
+ # Customize service error responses. For example, list any service specific
759
+ # protobuf types that can appear in error detail lists of error responses.
760
+ # Example: custom_error: types: - google.foo.v1.CustomError - google.foo.v1.
761
+ # AnotherError
864
762
  class CustomError
865
763
  include Google::Apis::Core::Hashable
866
764
 
867
- # The list of custom error rules that apply to individual API messages.
868
- # **NOTE:** All service configuration rules follow "last one wins" order.
765
+ # The list of custom error rules that apply to individual API messages. **NOTE:**
766
+ # All service configuration rules follow "last one wins" order.
869
767
  # Corresponds to the JSON property `rules`
870
768
  # @return [Array<Google::Apis::ServiceusageV1::CustomErrorRule>]
871
769
  attr_accessor :rules
@@ -890,15 +788,15 @@ module Google
890
788
  class CustomErrorRule
891
789
  include Google::Apis::Core::Hashable
892
790
 
893
- # Mark this message as possible payload in error response. Otherwise,
894
- # objects of this type will be filtered when they appear in error payload.
791
+ # Mark this message as possible payload in error response. Otherwise, objects of
792
+ # this type will be filtered when they appear in error payload.
895
793
  # Corresponds to the JSON property `isErrorType`
896
794
  # @return [Boolean]
897
795
  attr_accessor :is_error_type
898
796
  alias_method :is_error_type?, :is_error_type
899
797
 
900
- # Selects messages to which this rule applies.
901
- # Refer to selector for syntax details.
798
+ # Selects messages to which this rule applies. Refer to selector for syntax
799
+ # details.
902
800
  # Corresponds to the JSON property `selector`
903
801
  # @return [String]
904
802
  attr_accessor :selector
@@ -948,11 +846,10 @@ module Google
948
846
  # @return [String]
949
847
  attr_accessor :check_if_service_has_usage
950
848
 
951
- # Indicates if services that are enabled and which depend on this service
952
- # should also be disabled. If not set, an error will be generated if any
953
- # enabled services depend on the service to be disabled. When set, the
954
- # service, and any enabled services that depend on it, will be disabled
955
- # together.
849
+ # Indicates if services that are enabled and which depend on this service should
850
+ # also be disabled. If not set, an error will be generated if any enabled
851
+ # services depend on the service to be disabled. When set, the service, and any
852
+ # enabled services that depend on it, will be disabled together.
956
853
  # Corresponds to the JSON property `disableDependentServices`
957
854
  # @return [Boolean]
958
855
  attr_accessor :disable_dependent_services
@@ -969,9 +866,9 @@ module Google
969
866
  end
970
867
  end
971
868
 
972
- # Response message for the `DisableService` method.
973
- # This response message is assigned to the `response` field of the returned
974
- # Operation when that operation is done.
869
+ # Response message for the `DisableService` method. This response message is
870
+ # assigned to the `response` field of the returned Operation when that operation
871
+ # is done.
975
872
  class DisableServiceResponse
976
873
  include Google::Apis::Core::Hashable
977
874
 
@@ -990,56 +887,32 @@ module Google
990
887
  end
991
888
  end
992
889
 
993
- # `Documentation` provides the information for describing a service.
994
- # Example:
995
- # <pre><code>documentation:
996
- # summary: >
997
- # The Google Calendar API gives access
998
- # to most calendar features.
999
- # pages:
1000
- # - name: Overview
1001
- # content: &#40;== include google/foo/overview.md ==&#41;
1002
- # - name: Tutorial
1003
- # content: &#40;== include google/foo/tutorial.md ==&#41;
1004
- # subpages;
1005
- # - name: Java
1006
- # content: &#40;== include google/foo/tutorial_java.md ==&#41;
1007
- # rules:
1008
- # - selector: google.calendar.Calendar.Get
1009
- # description: >
1010
- # ...
1011
- # - selector: google.calendar.Calendar.Put
1012
- # description: >
1013
- # ...
1014
- # </code></pre>
1015
- # Documentation is provided in markdown syntax. In addition to
1016
- # standard markdown features, definition lists, tables and fenced
1017
- # code blocks are supported. Section headers can be provided and are
1018
- # interpreted relative to the section nesting of the context where
1019
- # a documentation fragment is embedded.
1020
- # Documentation from the IDL is merged with documentation defined
1021
- # via the config at normalization time, where documentation provided
1022
- # by config rules overrides IDL provided.
1023
- # A number of constructs specific to the API platform are supported
1024
- # in documentation text.
1025
- # In order to reference a proto element, the following
1026
- # notation can be used:
1027
- # <pre><code>&#91;fully.qualified.proto.name]&#91;]</code></pre>
1028
- # To override the display text used for the link, this can be used:
1029
- # <pre><code>&#91;display text]&#91;fully.qualified.proto.name]</code></pre>
1030
- # Text can be excluded from doc using the following notation:
1031
- # <pre><code>&#40;-- internal comment --&#41;</code></pre>
1032
- # A few directives are available in documentation. Note that
1033
- # directives must appear on a single line to be properly
1034
- # identified. The `include` directive includes a markdown file from
1035
- # an external source:
1036
- # <pre><code>&#40;== include path/to/file ==&#41;</code></pre>
1037
- # The `resource_for` directive marks a message to be the resource of
1038
- # a collection in REST view. If it is not specified, tools attempt
1039
- # to infer the resource from the operations in a collection:
1040
- # <pre><code>&#40;== resource_for v1.shelves.books ==&#41;</code></pre>
1041
- # The directive `suppress_warning` does not directly affect documentation
1042
- # and is documented together with service config validation.
890
+ # `Documentation` provides the information for describing a service. Example:
891
+ # documentation: summary: > The Google Calendar API gives access to most
892
+ # calendar features. pages: - name: Overview content: (== include google/foo/
893
+ # overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==
894
+ # ) subpages; - name: Java content: (== include google/foo/tutorial_java.md ==)
895
+ # rules: - selector: google.calendar.Calendar.Get description: > ... - selector:
896
+ # google.calendar.Calendar.Put description: > ... Documentation is provided in
897
+ # markdown syntax. In addition to standard markdown features, definition lists,
898
+ # tables and fenced code blocks are supported. Section headers can be provided
899
+ # and are interpreted relative to the section nesting of the context where a
900
+ # documentation fragment is embedded. Documentation from the IDL is merged with
901
+ # documentation defined via the config at normalization time, where
902
+ # documentation provided by config rules overrides IDL provided. A number of
903
+ # constructs specific to the API platform are supported in documentation text.
904
+ # In order to reference a proto element, the following notation can be used: [
905
+ # fully.qualified.proto.name][] To override the display text used for the link,
906
+ # this can be used: [display text][fully.qualified.proto.name] Text can be
907
+ # excluded from doc using the following notation: (-- internal comment --) A few
908
+ # directives are available in documentation. Note that directives must appear on
909
+ # a single line to be properly identified. The `include` directive includes a
910
+ # markdown file from an external source: (== include path/to/file ==) The `
911
+ # resource_for` directive marks a message to be the resource of a collection in
912
+ # REST view. If it is not specified, tools attempt to infer the resource from
913
+ # the operations in a collection: (== resource_for v1.shelves.books ==) The
914
+ # directive `suppress_warning` does not directly affect documentation and is
915
+ # documented together with service config validation.
1043
916
  class Documentation
1044
917
  include Google::Apis::Core::Hashable
1045
918
 
@@ -1048,19 +921,11 @@ module Google
1048
921
  # @return [String]
1049
922
  attr_accessor :documentation_root_url
1050
923
 
1051
- # Declares a single overview page. For example:
1052
- # <pre><code>documentation:
1053
- # summary: ...
1054
- # overview: &#40;== include overview.md ==&#41;
1055
- # </code></pre>
1056
- # This is a shortcut for the following declaration (using pages style):
1057
- # <pre><code>documentation:
1058
- # summary: ...
1059
- # pages:
1060
- # - name: Overview
1061
- # content: &#40;== include overview.md ==&#41;
1062
- # </code></pre>
1063
- # Note: you cannot specify both `overview` field and `pages` field.
924
+ # Declares a single overview page. For example: documentation: summary: ...
925
+ # overview: (== include overview.md ==) This is a shortcut for the following
926
+ # declaration (using pages style): documentation: summary: ... pages: - name:
927
+ # Overview content: (== include overview.md ==) Note: you cannot specify both `
928
+ # overview` field and `pages` field.
1064
929
  # Corresponds to the JSON property `overview`
1065
930
  # @return [String]
1066
931
  attr_accessor :overview
@@ -1070,22 +935,20 @@ module Google
1070
935
  # @return [Array<Google::Apis::ServiceusageV1::Page>]
1071
936
  attr_accessor :pages
1072
937
 
1073
- # A list of documentation rules that apply to individual API elements.
1074
- # **NOTE:** All service configuration rules follow "last one wins" order.
938
+ # A list of documentation rules that apply to individual API elements. **NOTE:**
939
+ # All service configuration rules follow "last one wins" order.
1075
940
  # Corresponds to the JSON property `rules`
1076
941
  # @return [Array<Google::Apis::ServiceusageV1::DocumentationRule>]
1077
942
  attr_accessor :rules
1078
943
 
1079
- # Specifies the service root url if the default one (the service name
1080
- # from the yaml file) is not suitable. This can be seen in any fully
1081
- # specified service urls as well as sections that show a base that other
1082
- # urls are relative to.
944
+ # Specifies the service root url if the default one (the service name from the
945
+ # yaml file) is not suitable. This can be seen in any fully specified service
946
+ # urls as well as sections that show a base that other urls are relative to.
1083
947
  # Corresponds to the JSON property `serviceRootUrl`
1084
948
  # @return [String]
1085
949
  attr_accessor :service_root_url
1086
950
 
1087
- # A short summary of what the service does. Can only be provided by
1088
- # plain text.
951
+ # A short summary of what the service does. Can only be provided by plain text.
1089
952
  # Corresponds to the JSON property `summary`
1090
953
  # @return [String]
1091
954
  attr_accessor :summary
@@ -1109,8 +972,8 @@ module Google
1109
972
  class DocumentationRule
1110
973
  include Google::Apis::Core::Hashable
1111
974
 
1112
- # Deprecation description of the selected element(s). It can be provided if
1113
- # an element is marked as `deprecated`.
975
+ # Deprecation description of the selected element(s). It can be provided if an
976
+ # element is marked as `deprecated`.
1114
977
  # Corresponds to the JSON property `deprecationDescription`
1115
978
  # @return [String]
1116
979
  attr_accessor :deprecation_description
@@ -1142,13 +1005,11 @@ module Google
1142
1005
  end
1143
1006
  end
1144
1007
 
1145
- # A generic empty message that you can re-use to avoid defining duplicated
1146
- # empty messages in your APIs. A typical example is to use it as the request
1147
- # or the response type of an API method. For instance:
1148
- # service Foo `
1149
- # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
1150
- # `
1151
- # The JSON representation for `Empty` is empty JSON object ````.
1008
+ # A generic empty message that you can re-use to avoid defining duplicated empty
1009
+ # messages in your APIs. A typical example is to use it as the request or the
1010
+ # response type of an API method. For instance: service Foo ` rpc Bar(google.
1011
+ # protobuf.Empty) returns (google.protobuf.Empty); ` The JSON representation for
1012
+ # `Empty` is empty JSON object ````.
1152
1013
  class Empty
1153
1014
  include Google::Apis::Core::Hashable
1154
1015
 
@@ -1199,9 +1060,9 @@ module Google
1199
1060
  end
1200
1061
  end
1201
1062
 
1202
- # Response message for the `EnableService` method.
1203
- # This response message is assigned to the `response` field of the returned
1204
- # Operation when that operation is done.
1063
+ # Response message for the `EnableService` method. This response message is
1064
+ # assigned to the `response` field of the returned Operation when that operation
1065
+ # is done.
1205
1066
  class EnableServiceResponse
1206
1067
  include Google::Apis::Core::Hashable
1207
1068
 
@@ -1220,35 +1081,28 @@ module Google
1220
1081
  end
1221
1082
  end
1222
1083
 
1223
- # `Endpoint` describes a network endpoint that serves a set of APIs.
1224
- # A service may expose any number of endpoints, and all endpoints share the
1225
- # same service configuration, such as quota configuration and monitoring
1226
- # configuration.
1227
- # Example service configuration:
1228
- # name: library-example.googleapis.com
1229
- # endpoints:
1230
- # # Below entry makes 'google.example.library.v1.Library'
1231
- # # API be served from endpoint address library-example.googleapis.com.
1232
- # # It also allows HTTP OPTIONS calls to be passed to the backend, for
1233
- # # it to decide whether the subsequent cross-origin request is
1234
- # # allowed to proceed.
1235
- # - name: library-example.googleapis.com
1236
- # allow_cors: true
1084
+ # `Endpoint` describes a network endpoint that serves a set of APIs. A service
1085
+ # may expose any number of endpoints, and all endpoints share the same service
1086
+ # configuration, such as quota configuration and monitoring configuration.
1087
+ # Example service configuration: name: library-example.googleapis.com endpoints:
1088
+ # # Below entry makes 'google.example.library.v1.Library' # API be served from
1089
+ # endpoint address library-example.googleapis.com. # It also allows HTTP OPTIONS
1090
+ # calls to be passed to the backend, for # it to decide whether the subsequent
1091
+ # cross-origin request is # allowed to proceed. - name: library-example.
1092
+ # googleapis.com allow_cors: true
1237
1093
  class Endpoint
1238
1094
  include Google::Apis::Core::Hashable
1239
1095
 
1240
1096
  # DEPRECATED: This field is no longer supported. Instead of using aliases,
1241
- # please specify multiple google.api.Endpoint for each of the intended
1242
- # aliases.
1097
+ # please specify multiple google.api.Endpoint for each of the intended aliases.
1243
1098
  # Additional names that this endpoint will be hosted on.
1244
1099
  # Corresponds to the JSON property `aliases`
1245
1100
  # @return [Array<String>]
1246
1101
  attr_accessor :aliases
1247
1102
 
1248
- # Allowing
1249
- # [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka
1250
- # cross-domain traffic, would allow the backends served from this endpoint to
1251
- # receive and respond to HTTP OPTIONS requests. The response will be used by
1103
+ # Allowing [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing),
1104
+ # aka cross-domain traffic, would allow the backends served from this endpoint
1105
+ # to receive and respond to HTTP OPTIONS requests. The response will be used by
1252
1106
  # the browser to determine whether the subsequent cross-origin request is
1253
1107
  # allowed to proceed.
1254
1108
  # Corresponds to the JSON property `allowCors`
@@ -1262,10 +1116,9 @@ module Google
1262
1116
  attr_accessor :name
1263
1117
 
1264
1118
  # The specification of an Internet routable address of API frontend that will
1265
- # handle requests to this [API
1266
- # Endpoint](https://cloud.google.com/apis/design/glossary). It should be
1267
- # either a valid IPv4 address or a fully-qualified domain name. For example,
1268
- # "8.8.8.8" or "myservice.appspot.com".
1119
+ # handle requests to this [API Endpoint](https://cloud.google.com/apis/design/
1120
+ # glossary). It should be either a valid IPv4 address or a fully-qualified
1121
+ # domain name. For example, "8.8.8.8" or "myservice.appspot.com".
1269
1122
  # Corresponds to the JSON property `target`
1270
1123
  # @return [String]
1271
1124
  attr_accessor :target
@@ -1302,8 +1155,8 @@ module Google
1302
1155
  # @return [Array<Google::Apis::ServiceusageV1::Option>]
1303
1156
  attr_accessor :options
1304
1157
 
1305
- # `SourceContext` represents information about the source of a
1306
- # protobuf element, like the file in which it is defined.
1158
+ # `SourceContext` represents information about the source of a protobuf element,
1159
+ # like the file in which it is defined.
1307
1160
  # Corresponds to the JSON property `sourceContext`
1308
1161
  # @return [Google::Apis::ServiceusageV1::SourceContext]
1309
1162
  attr_accessor :source_context
@@ -1392,8 +1245,8 @@ module Google
1392
1245
  # @return [Fixnum]
1393
1246
  attr_accessor :number
1394
1247
 
1395
- # The index of the field type in `Type.oneofs`, for message or enumeration
1396
- # types. The first type has index 1; zero means the type is not in the list.
1248
+ # The index of the field type in `Type.oneofs`, for message or enumeration types.
1249
+ # The first type has index 1; zero means the type is not in the list.
1397
1250
  # Corresponds to the JSON property `oneofIndex`
1398
1251
  # @return [Fixnum]
1399
1252
  attr_accessor :oneof_index
@@ -1409,8 +1262,8 @@ module Google
1409
1262
  attr_accessor :packed
1410
1263
  alias_method :packed?, :packed
1411
1264
 
1412
- # The field type URL, without the scheme, for message or enumeration
1413
- # types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`.
1265
+ # The field type URL, without the scheme, for message or enumeration types.
1266
+ # Example: `"type.googleapis.com/google.protobuf.Timestamp"`.
1414
1267
  # Corresponds to the JSON property `typeUrl`
1415
1268
  # @return [String]
1416
1269
  attr_accessor :type_url
@@ -1461,50 +1314,32 @@ module Google
1461
1314
  end
1462
1315
 
1463
1316
  # `Service` is the root object of Google service configuration schema. It
1464
- # describes basic information about a service, such as the name and the
1465
- # title, and delegates other aspects to sub-sections. Each sub-section is
1466
- # either a proto message or a repeated proto message that configures a
1467
- # specific aspect, such as auth. See each proto message definition for details.
1468
- # Example:
1469
- # type: google.api.Service
1470
- # config_version: 3
1471
- # name: calendar.googleapis.com
1472
- # title: Google Calendar API
1473
- # apis:
1474
- # - name: google.calendar.v3.Calendar
1475
- # authentication:
1476
- # providers:
1477
- # - id: google_calendar_auth
1478
- # jwks_uri: https://www.googleapis.com/oauth2/v1/certs
1479
- # issuer: https://securetoken.google.com
1480
- # rules:
1481
- # - selector: "*"
1482
- # requirements:
1483
- # provider_id: google_calendar_auth
1317
+ # describes basic information about a service, such as the name and the title,
1318
+ # and delegates other aspects to sub-sections. Each sub-section is either a
1319
+ # proto message or a repeated proto message that configures a specific aspect,
1320
+ # such as auth. See each proto message definition for details. Example: type:
1321
+ # google.api.Service config_version: 3 name: calendar.googleapis.com title:
1322
+ # Google Calendar API apis: - name: google.calendar.v3.Calendar authentication:
1323
+ # providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/
1324
+ # oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: "*"
1325
+ # requirements: provider_id: google_calendar_auth
1484
1326
  class GoogleApiService
1485
1327
  include Google::Apis::Core::Hashable
1486
1328
 
1487
- # A list of API interfaces exported by this service. Only the `name` field
1488
- # of the google.protobuf.Api needs to be provided by the configuration
1489
- # author, as the remaining fields will be derived from the IDL during the
1490
- # normalization process. It is an error to specify an API interface here
1491
- # which cannot be resolved against the associated IDL files.
1329
+ # A list of API interfaces exported by this service. Only the `name` field of
1330
+ # the google.protobuf.Api needs to be provided by the configuration author, as
1331
+ # the remaining fields will be derived from the IDL during the normalization
1332
+ # process. It is an error to specify an API interface here which cannot be
1333
+ # resolved against the associated IDL files.
1492
1334
  # Corresponds to the JSON property `apis`
1493
1335
  # @return [Array<Google::Apis::ServiceusageV1::Api>]
1494
1336
  attr_accessor :apis
1495
1337
 
1496
- # `Authentication` defines the authentication configuration for an API.
1497
- # Example for an API targeted for external use:
1498
- # name: calendar.googleapis.com
1499
- # authentication:
1500
- # providers:
1501
- # - id: google_calendar_auth
1502
- # jwks_uri: https://www.googleapis.com/oauth2/v1/certs
1503
- # issuer: https://securetoken.google.com
1504
- # rules:
1505
- # - selector: "*"
1506
- # requirements:
1507
- # provider_id: google_calendar_auth
1338
+ # `Authentication` defines the authentication configuration for an API. Example
1339
+ # for an API targeted for external use: name: calendar.googleapis.com
1340
+ # authentication: providers: - id: google_calendar_auth jwks_uri: https://www.
1341
+ # googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: -
1342
+ # selector: "*" requirements: provider_id: google_calendar_auth
1508
1343
  # Corresponds to the JSON property `authentication`
1509
1344
  # @return [Google::Apis::ServiceusageV1::Authentication]
1510
1345
  attr_accessor :authentication
@@ -1514,211 +1349,136 @@ module Google
1514
1349
  # @return [Google::Apis::ServiceusageV1::Backend]
1515
1350
  attr_accessor :backend
1516
1351
 
1517
- # Billing related configuration of the service.
1518
- # The following example shows how to configure monitored resources and metrics
1519
- # for billing, `consumer_destinations` is the only supported destination and
1520
- # the monitored resources need at least one label key
1521
- # `cloud.googleapis.com/location` to indicate the location of the billing
1522
- # usage, using different monitored resources between monitoring and billing is
1523
- # recommended so they can be evolved independently:
1524
- # monitored_resources:
1525
- # - type: library.googleapis.com/billing_branch
1526
- # labels:
1527
- # - key: cloud.googleapis.com/location
1528
- # description: |
1529
- # Predefined label to support billing location restriction.
1530
- # - key: city
1531
- # description: |
1532
- # Custom label to define the city where the library branch is located
1533
- # in.
1534
- # - key: name
1535
- # description: Custom label to define the name of the library branch.
1536
- # metrics:
1537
- # - name: library.googleapis.com/book/borrowed_count
1538
- # metric_kind: DELTA
1539
- # value_type: INT64
1540
- # unit: "1"
1541
- # billing:
1542
- # consumer_destinations:
1543
- # - monitored_resource: library.googleapis.com/billing_branch
1544
- # metrics:
1545
- # - library.googleapis.com/book/borrowed_count
1352
+ # Billing related configuration of the service. The following example shows how
1353
+ # to configure monitored resources and metrics for billing, `
1354
+ # consumer_destinations` is the only supported destination and the monitored
1355
+ # resources need at least one label key `cloud.googleapis.com/location` to
1356
+ # indicate the location of the billing usage, using different monitored
1357
+ # resources between monitoring and billing is recommended so they can be evolved
1358
+ # independently: monitored_resources: - type: library.googleapis.com/
1359
+ # billing_branch labels: - key: cloud.googleapis.com/location description: |
1360
+ # Predefined label to support billing location restriction. - key: city
1361
+ # description: | Custom label to define the city where the library branch is
1362
+ # located in. - key: name description: Custom label to define the name of the
1363
+ # library branch. metrics: - name: library.googleapis.com/book/borrowed_count
1364
+ # metric_kind: DELTA value_type: INT64 unit: "1" billing: consumer_destinations:
1365
+ # - monitored_resource: library.googleapis.com/billing_branch metrics: - library.
1366
+ # googleapis.com/book/borrowed_count
1546
1367
  # Corresponds to the JSON property `billing`
1547
1368
  # @return [Google::Apis::ServiceusageV1::Billing]
1548
1369
  attr_accessor :billing
1549
1370
 
1550
- # The semantic version of the service configuration. The config version
1551
- # affects the interpretation of the service configuration. For example,
1552
- # certain features are enabled by default for certain config versions.
1553
- # The latest config version is `3`.
1371
+ # The semantic version of the service configuration. The config version affects
1372
+ # the interpretation of the service configuration. For example, certain features
1373
+ # are enabled by default for certain config versions. The latest config version
1374
+ # is `3`.
1554
1375
  # Corresponds to the JSON property `configVersion`
1555
1376
  # @return [Fixnum]
1556
1377
  attr_accessor :config_version
1557
1378
 
1558
- # `Context` defines which contexts an API requests.
1559
- # Example:
1560
- # context:
1561
- # rules:
1562
- # - selector: "*"
1563
- # requested:
1564
- # - google.rpc.context.ProjectContext
1565
- # - google.rpc.context.OriginContext
1566
- # The above specifies that all methods in the API request
1567
- # `google.rpc.context.ProjectContext` and
1568
- # `google.rpc.context.OriginContext`.
1569
- # Available context types are defined in package
1570
- # `google.rpc.context`.
1571
- # This also provides mechanism to whitelist any protobuf message extension that
1572
- # can be sent in grpc metadata using “x-goog-ext-<extension_id>-bin” and
1573
- # “x-goog-ext-<extension_id>-jspb” format. For example, list any service
1574
- # specific protobuf types that can appear in grpc metadata as follows in your
1575
- # yaml file:
1576
- # Example:
1577
- # context:
1578
- # rules:
1579
- # - selector: "google.example.library.v1.LibraryService.CreateBook"
1580
- # allowed_request_extensions:
1581
- # - google.foo.v1.NewExtension
1582
- # allowed_response_extensions:
1583
- # - google.foo.v1.NewExtension
1584
- # You can also specify extension ID instead of fully qualified extension name
1585
- # here.
1379
+ # `Context` defines which contexts an API requests. Example: context: rules: -
1380
+ # selector: "*" requested: - google.rpc.context.ProjectContext - google.rpc.
1381
+ # context.OriginContext The above specifies that all methods in the API request `
1382
+ # google.rpc.context.ProjectContext` and `google.rpc.context.OriginContext`.
1383
+ # Available context types are defined in package `google.rpc.context`. This also
1384
+ # provides mechanism to whitelist any protobuf message extension that can be
1385
+ # sent in grpc metadata using “x-goog-ext--bin” and “x-goog-ext--jspb” format.
1386
+ # For example, list any service specific protobuf types that can appear in grpc
1387
+ # metadata as follows in your yaml file: Example: context: rules: - selector: "
1388
+ # google.example.library.v1.LibraryService.CreateBook"
1389
+ # allowed_request_extensions: - google.foo.v1.NewExtension
1390
+ # allowed_response_extensions: - google.foo.v1.NewExtension You can also specify
1391
+ # extension ID instead of fully qualified extension name here.
1586
1392
  # Corresponds to the JSON property `context`
1587
1393
  # @return [Google::Apis::ServiceusageV1::Context]
1588
1394
  attr_accessor :context
1589
1395
 
1590
- # Selects and configures the service controller used by the service. The
1591
- # service controller handles features like abuse, quota, billing, logging,
1592
- # monitoring, etc.
1396
+ # Selects and configures the service controller used by the service. The service
1397
+ # controller handles features like abuse, quota, billing, logging, monitoring,
1398
+ # etc.
1593
1399
  # Corresponds to the JSON property `control`
1594
1400
  # @return [Google::Apis::ServiceusageV1::Control]
1595
1401
  attr_accessor :control
1596
1402
 
1597
- # Customize service error responses. For example, list any service
1598
- # specific protobuf types that can appear in error detail lists of
1599
- # error responses.
1600
- # Example:
1601
- # custom_error:
1602
- # types:
1603
- # - google.foo.v1.CustomError
1604
- # - google.foo.v1.AnotherError
1403
+ # Customize service error responses. For example, list any service specific
1404
+ # protobuf types that can appear in error detail lists of error responses.
1405
+ # Example: custom_error: types: - google.foo.v1.CustomError - google.foo.v1.
1406
+ # AnotherError
1605
1407
  # Corresponds to the JSON property `customError`
1606
1408
  # @return [Google::Apis::ServiceusageV1::CustomError]
1607
1409
  attr_accessor :custom_error
1608
1410
 
1609
- # `Documentation` provides the information for describing a service.
1610
- # Example:
1611
- # <pre><code>documentation:
1612
- # summary: >
1613
- # The Google Calendar API gives access
1614
- # to most calendar features.
1615
- # pages:
1616
- # - name: Overview
1617
- # content: &#40;== include google/foo/overview.md ==&#41;
1618
- # - name: Tutorial
1619
- # content: &#40;== include google/foo/tutorial.md ==&#41;
1620
- # subpages;
1621
- # - name: Java
1622
- # content: &#40;== include google/foo/tutorial_java.md ==&#41;
1623
- # rules:
1624
- # - selector: google.calendar.Calendar.Get
1625
- # description: >
1626
- # ...
1627
- # - selector: google.calendar.Calendar.Put
1628
- # description: >
1629
- # ...
1630
- # </code></pre>
1631
- # Documentation is provided in markdown syntax. In addition to
1632
- # standard markdown features, definition lists, tables and fenced
1633
- # code blocks are supported. Section headers can be provided and are
1634
- # interpreted relative to the section nesting of the context where
1635
- # a documentation fragment is embedded.
1636
- # Documentation from the IDL is merged with documentation defined
1637
- # via the config at normalization time, where documentation provided
1638
- # by config rules overrides IDL provided.
1639
- # A number of constructs specific to the API platform are supported
1640
- # in documentation text.
1641
- # In order to reference a proto element, the following
1642
- # notation can be used:
1643
- # <pre><code>&#91;fully.qualified.proto.name]&#91;]</code></pre>
1644
- # To override the display text used for the link, this can be used:
1645
- # <pre><code>&#91;display text]&#91;fully.qualified.proto.name]</code></pre>
1646
- # Text can be excluded from doc using the following notation:
1647
- # <pre><code>&#40;-- internal comment --&#41;</code></pre>
1648
- # A few directives are available in documentation. Note that
1649
- # directives must appear on a single line to be properly
1650
- # identified. The `include` directive includes a markdown file from
1651
- # an external source:
1652
- # <pre><code>&#40;== include path/to/file ==&#41;</code></pre>
1653
- # The `resource_for` directive marks a message to be the resource of
1654
- # a collection in REST view. If it is not specified, tools attempt
1655
- # to infer the resource from the operations in a collection:
1656
- # <pre><code>&#40;== resource_for v1.shelves.books ==&#41;</code></pre>
1657
- # The directive `suppress_warning` does not directly affect documentation
1658
- # and is documented together with service config validation.
1411
+ # `Documentation` provides the information for describing a service. Example:
1412
+ # documentation: summary: > The Google Calendar API gives access to most
1413
+ # calendar features. pages: - name: Overview content: (== include google/foo/
1414
+ # overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==
1415
+ # ) subpages; - name: Java content: (== include google/foo/tutorial_java.md ==)
1416
+ # rules: - selector: google.calendar.Calendar.Get description: > ... - selector:
1417
+ # google.calendar.Calendar.Put description: > ... Documentation is provided in
1418
+ # markdown syntax. In addition to standard markdown features, definition lists,
1419
+ # tables and fenced code blocks are supported. Section headers can be provided
1420
+ # and are interpreted relative to the section nesting of the context where a
1421
+ # documentation fragment is embedded. Documentation from the IDL is merged with
1422
+ # documentation defined via the config at normalization time, where
1423
+ # documentation provided by config rules overrides IDL provided. A number of
1424
+ # constructs specific to the API platform are supported in documentation text.
1425
+ # In order to reference a proto element, the following notation can be used: [
1426
+ # fully.qualified.proto.name][] To override the display text used for the link,
1427
+ # this can be used: [display text][fully.qualified.proto.name] Text can be
1428
+ # excluded from doc using the following notation: (-- internal comment --) A few
1429
+ # directives are available in documentation. Note that directives must appear on
1430
+ # a single line to be properly identified. The `include` directive includes a
1431
+ # markdown file from an external source: (== include path/to/file ==) The `
1432
+ # resource_for` directive marks a message to be the resource of a collection in
1433
+ # REST view. If it is not specified, tools attempt to infer the resource from
1434
+ # the operations in a collection: (== resource_for v1.shelves.books ==) The
1435
+ # directive `suppress_warning` does not directly affect documentation and is
1436
+ # documented together with service config validation.
1659
1437
  # Corresponds to the JSON property `documentation`
1660
1438
  # @return [Google::Apis::ServiceusageV1::Documentation]
1661
1439
  attr_accessor :documentation
1662
1440
 
1663
- # Configuration for network endpoints. If this is empty, then an endpoint
1664
- # with the same name as the service is automatically generated to service all
1665
- # defined APIs.
1441
+ # Configuration for network endpoints. If this is empty, then an endpoint with
1442
+ # the same name as the service is automatically generated to service all defined
1443
+ # APIs.
1666
1444
  # Corresponds to the JSON property `endpoints`
1667
1445
  # @return [Array<Google::Apis::ServiceusageV1::Endpoint>]
1668
1446
  attr_accessor :endpoints
1669
1447
 
1670
- # A list of all enum types included in this API service. Enums
1671
- # referenced directly or indirectly by the `apis` are automatically
1672
- # included. Enums which are not referenced but shall be included
1673
- # should be listed here by name. Example:
1674
- # enums:
1675
- # - name: google.someapi.v1.SomeEnum
1448
+ # A list of all enum types included in this API service. Enums referenced
1449
+ # directly or indirectly by the `apis` are automatically included. Enums which
1450
+ # are not referenced but shall be included should be listed here by name.
1451
+ # Example: enums: - name: google.someapi.v1.SomeEnum
1676
1452
  # Corresponds to the JSON property `enums`
1677
1453
  # @return [Array<Google::Apis::ServiceusageV1::Enum>]
1678
1454
  attr_accessor :enums
1679
1455
 
1680
1456
  # Defines the HTTP configuration for an API service. It contains a list of
1681
- # HttpRule, each specifying the mapping of an RPC method
1682
- # to one or more HTTP REST API methods.
1457
+ # HttpRule, each specifying the mapping of an RPC method to one or more HTTP
1458
+ # REST API methods.
1683
1459
  # Corresponds to the JSON property `http`
1684
1460
  # @return [Google::Apis::ServiceusageV1::Http]
1685
1461
  attr_accessor :http
1686
1462
 
1687
- # A unique ID for a specific instance of this message, typically assigned
1688
- # by the client for tracking purpose. Must be no longer than 63 characters
1689
- # and only lower case letters, digits, '.', '_' and '-' are allowed. If
1690
- # empty, the server may choose to generate one instead.
1463
+ # A unique ID for a specific instance of this message, typically assigned by the
1464
+ # client for tracking purpose. Must be no longer than 63 characters and only
1465
+ # lower case letters, digits, '.', '_' and '-' are allowed. If empty, the server
1466
+ # may choose to generate one instead.
1691
1467
  # Corresponds to the JSON property `id`
1692
1468
  # @return [String]
1693
1469
  attr_accessor :id
1694
1470
 
1695
- # Logging configuration of the service.
1696
- # The following example shows how to configure logs to be sent to the
1697
- # producer and consumer projects. In the example, the `activity_history`
1698
- # log is sent to both the producer and consumer projects, whereas the
1699
- # `purchase_history` log is only sent to the producer project.
1700
- # monitored_resources:
1701
- # - type: library.googleapis.com/branch
1702
- # labels:
1703
- # - key: /city
1704
- # description: The city where the library branch is located in.
1705
- # - key: /name
1706
- # description: The name of the branch.
1707
- # logs:
1708
- # - name: activity_history
1709
- # labels:
1710
- # - key: /customer_id
1711
- # - name: purchase_history
1712
- # logging:
1713
- # producer_destinations:
1714
- # - monitored_resource: library.googleapis.com/branch
1715
- # logs:
1716
- # - activity_history
1717
- # - purchase_history
1718
- # consumer_destinations:
1719
- # - monitored_resource: library.googleapis.com/branch
1720
- # logs:
1721
- # - activity_history
1471
+ # Logging configuration of the service. The following example shows how to
1472
+ # configure logs to be sent to the producer and consumer projects. In the
1473
+ # example, the `activity_history` log is sent to both the producer and consumer
1474
+ # projects, whereas the `purchase_history` log is only sent to the producer
1475
+ # project. monitored_resources: - type: library.googleapis.com/branch labels: -
1476
+ # key: /city description: The city where the library branch is located in. - key:
1477
+ # /name description: The name of the branch. logs: - name: activity_history
1478
+ # labels: - key: /customer_id - name: purchase_history logging:
1479
+ # producer_destinations: - monitored_resource: library.googleapis.com/branch
1480
+ # logs: - activity_history - purchase_history consumer_destinations: -
1481
+ # monitored_resource: library.googleapis.com/branch logs: - activity_history
1722
1482
  # Corresponds to the JSON property `logging`
1723
1483
  # @return [Google::Apis::ServiceusageV1::Logging]
1724
1484
  attr_accessor :logging
@@ -1733,70 +1493,41 @@ module Google
1733
1493
  # @return [Array<Google::Apis::ServiceusageV1::MetricDescriptor>]
1734
1494
  attr_accessor :metrics
1735
1495
 
1736
- # Defines the monitored resources used by this service. This is required
1737
- # by the Service.monitoring and Service.logging configurations.
1496
+ # Defines the monitored resources used by this service. This is required by the
1497
+ # Service.monitoring and Service.logging configurations.
1738
1498
  # Corresponds to the JSON property `monitoredResources`
1739
1499
  # @return [Array<Google::Apis::ServiceusageV1::MonitoredResourceDescriptor>]
1740
1500
  attr_accessor :monitored_resources
1741
1501
 
1742
- # Monitoring configuration of the service.
1743
- # The example below shows how to configure monitored resources and metrics
1744
- # for monitoring. In the example, a monitored resource and two metrics are
1745
- # defined. The `library.googleapis.com/book/returned_count` metric is sent
1746
- # to both producer and consumer projects, whereas the
1747
- # `library.googleapis.com/book/num_overdue` metric is only sent to the
1748
- # consumer project.
1749
- # monitored_resources:
1750
- # - type: library.googleapis.com/Branch
1751
- # display_name: "Library Branch"
1752
- # description: "A branch of a library."
1753
- # launch_stage: GA
1754
- # labels:
1755
- # - key: resource_container
1756
- # description: "The Cloud container (ie. project id) for the Branch."
1757
- # - key: location
1758
- # description: "The location of the library branch."
1759
- # - key: branch_id
1760
- # description: "The id of the branch."
1761
- # metrics:
1762
- # - name: library.googleapis.com/book/returned_count
1763
- # display_name: "Books Returned"
1764
- # description: "The count of books that have been returned."
1765
- # launch_stage: GA
1766
- # metric_kind: DELTA
1767
- # value_type: INT64
1768
- # unit: "1"
1769
- # labels:
1770
- # - key: customer_id
1771
- # description: "The id of the customer."
1772
- # - name: library.googleapis.com/book/num_overdue
1773
- # display_name: "Books Overdue"
1774
- # description: "The current number of overdue books."
1775
- # launch_stage: GA
1776
- # metric_kind: GAUGE
1777
- # value_type: INT64
1778
- # unit: "1"
1779
- # labels:
1780
- # - key: customer_id
1781
- # description: "The id of the customer."
1782
- # monitoring:
1783
- # producer_destinations:
1784
- # - monitored_resource: library.googleapis.com/Branch
1785
- # metrics:
1786
- # - library.googleapis.com/book/returned_count
1787
- # consumer_destinations:
1788
- # - monitored_resource: library.googleapis.com/Branch
1789
- # metrics:
1790
- # - library.googleapis.com/book/returned_count
1791
- # - library.googleapis.com/book/num_overdue
1502
+ # Monitoring configuration of the service. The example below shows how to
1503
+ # configure monitored resources and metrics for monitoring. In the example, a
1504
+ # monitored resource and two metrics are defined. The `library.googleapis.com/
1505
+ # book/returned_count` metric is sent to both producer and consumer projects,
1506
+ # whereas the `library.googleapis.com/book/num_overdue` metric is only sent to
1507
+ # the consumer project. monitored_resources: - type: library.googleapis.com/
1508
+ # Branch display_name: "Library Branch" description: "A branch of a library."
1509
+ # launch_stage: GA labels: - key: resource_container description: "The Cloud
1510
+ # container (ie. project id) for the Branch." - key: location description: "The
1511
+ # location of the library branch." - key: branch_id description: "The id of the
1512
+ # branch." metrics: - name: library.googleapis.com/book/returned_count
1513
+ # display_name: "Books Returned" description: "The count of books that have been
1514
+ # returned." launch_stage: GA metric_kind: DELTA value_type: INT64 unit: "1"
1515
+ # labels: - key: customer_id description: "The id of the customer." - name:
1516
+ # library.googleapis.com/book/num_overdue display_name: "Books Overdue"
1517
+ # description: "The current number of overdue books." launch_stage: GA
1518
+ # metric_kind: GAUGE value_type: INT64 unit: "1" labels: - key: customer_id
1519
+ # description: "The id of the customer." monitoring: producer_destinations: -
1520
+ # monitored_resource: library.googleapis.com/Branch metrics: - library.
1521
+ # googleapis.com/book/returned_count consumer_destinations: - monitored_resource:
1522
+ # library.googleapis.com/Branch metrics: - library.googleapis.com/book/
1523
+ # returned_count - library.googleapis.com/book/num_overdue
1792
1524
  # Corresponds to the JSON property `monitoring`
1793
1525
  # @return [Google::Apis::ServiceusageV1::Monitoring]
1794
1526
  attr_accessor :monitoring
1795
1527
 
1796
- # The service name, which is a DNS-like logical identifier for the
1797
- # service, such as `calendar.googleapis.com`. The service name
1798
- # typically goes through DNS verification to make sure the owner
1799
- # of the service also owns the DNS name.
1528
+ # The service name, which is a DNS-like logical identifier for the service, such
1529
+ # as `calendar.googleapis.com`. The service name typically goes through DNS
1530
+ # verification to make sure the owner of the service also owns the DNS name.
1800
1531
  # Corresponds to the JSON property `name`
1801
1532
  # @return [String]
1802
1533
  attr_accessor :name
@@ -1806,46 +1537,25 @@ module Google
1806
1537
  # @return [String]
1807
1538
  attr_accessor :producer_project_id
1808
1539
 
1809
- # Quota configuration helps to achieve fairness and budgeting in service
1810
- # usage.
1811
- # The metric based quota configuration works this way:
1812
- # - The service configuration defines a set of metrics.
1813
- # - For API calls, the quota.metric_rules maps methods to metrics with
1814
- # corresponding costs.
1815
- # - The quota.limits defines limits on the metrics, which will be used for
1816
- # quota checks at runtime.
1817
- # An example quota configuration in yaml format:
1818
- # quota:
1819
- # limits:
1820
- # - name: apiWriteQpsPerProject
1821
- # metric: library.googleapis.com/write_calls
1822
- # unit: "1/min/`project`" # rate limit for consumer projects
1823
- # values:
1824
- # STANDARD: 10000
1825
- # # The metric rules bind all methods to the read_calls metric,
1826
- # # except for the UpdateBook and DeleteBook methods. These two methods
1827
- # # are mapped to the write_calls metric, with the UpdateBook method
1828
- # # consuming at twice rate as the DeleteBook method.
1829
- # metric_rules:
1830
- # - selector: "*"
1831
- # metric_costs:
1832
- # library.googleapis.com/read_calls: 1
1833
- # - selector: google.example.library.v1.LibraryService.UpdateBook
1834
- # metric_costs:
1835
- # library.googleapis.com/write_calls: 2
1836
- # - selector: google.example.library.v1.LibraryService.DeleteBook
1837
- # metric_costs:
1838
- # library.googleapis.com/write_calls: 1
1839
- # Corresponding Metric definition:
1840
- # metrics:
1841
- # - name: library.googleapis.com/read_calls
1842
- # display_name: Read requests
1843
- # metric_kind: DELTA
1844
- # value_type: INT64
1845
- # - name: library.googleapis.com/write_calls
1846
- # display_name: Write requests
1847
- # metric_kind: DELTA
1848
- # value_type: INT64
1540
+ # Quota configuration helps to achieve fairness and budgeting in service usage.
1541
+ # The metric based quota configuration works this way: - The service
1542
+ # configuration defines a set of metrics. - For API calls, the quota.
1543
+ # metric_rules maps methods to metrics with corresponding costs. - The quota.
1544
+ # limits defines limits on the metrics, which will be used for quota checks at
1545
+ # runtime. An example quota configuration in yaml format: quota: limits: - name:
1546
+ # apiWriteQpsPerProject metric: library.googleapis.com/write_calls unit: "1/min/`
1547
+ # project`" # rate limit for consumer projects values: STANDARD: 10000 # The
1548
+ # metric rules bind all methods to the read_calls metric, # except for the
1549
+ # UpdateBook and DeleteBook methods. These two methods # are mapped to the
1550
+ # write_calls metric, with the UpdateBook method # consuming at twice rate as
1551
+ # the DeleteBook method. metric_rules: - selector: "*" metric_costs: library.
1552
+ # googleapis.com/read_calls: 1 - selector: google.example.library.v1.
1553
+ # LibraryService.UpdateBook metric_costs: library.googleapis.com/write_calls: 2 -
1554
+ # selector: google.example.library.v1.LibraryService.DeleteBook metric_costs:
1555
+ # library.googleapis.com/write_calls: 1 Corresponding Metric definition: metrics:
1556
+ # - name: library.googleapis.com/read_calls display_name: Read requests
1557
+ # metric_kind: DELTA value_type: INT64 - name: library.googleapis.com/
1558
+ # write_calls display_name: Write requests metric_kind: DELTA value_type: INT64
1849
1559
  # Corresponds to the JSON property `quota`
1850
1560
  # @return [Google::Apis::ServiceusageV1::Quota]
1851
1561
  attr_accessor :quota
@@ -1855,20 +1565,18 @@ module Google
1855
1565
  # @return [Google::Apis::ServiceusageV1::SourceInfo]
1856
1566
  attr_accessor :source_info
1857
1567
 
1858
- # ### System parameter configuration
1859
- # A system parameter is a special kind of parameter defined by the API
1860
- # system, not by an individual API. It is typically mapped to an HTTP header
1861
- # and/or a URL query parameter. This configuration specifies which methods
1862
- # change the names of the system parameters.
1568
+ # ### System parameter configuration A system parameter is a special kind of
1569
+ # parameter defined by the API system, not by an individual API. It is typically
1570
+ # mapped to an HTTP header and/or a URL query parameter. This configuration
1571
+ # specifies which methods change the names of the system parameters.
1863
1572
  # Corresponds to the JSON property `systemParameters`
1864
1573
  # @return [Google::Apis::ServiceusageV1::SystemParameters]
1865
1574
  attr_accessor :system_parameters
1866
1575
 
1867
- # A list of all proto message types included in this API service.
1868
- # It serves similar purpose as [google.api.Service.types], except that
1869
- # these types are not needed by user-defined APIs. Therefore, they will not
1870
- # show up in the generated discovery doc. This field should only be used
1871
- # to define system APIs in ESF.
1576
+ # A list of all proto message types included in this API service. It serves
1577
+ # similar purpose as [google.api.Service.types], except that these types are not
1578
+ # needed by user-defined APIs. Therefore, they will not show up in the generated
1579
+ # discovery doc. This field should only be used to define system APIs in ESF.
1872
1580
  # Corresponds to the JSON property `systemTypes`
1873
1581
  # @return [Array<Google::Apis::ServiceusageV1::Type>]
1874
1582
  attr_accessor :system_types
@@ -1878,12 +1586,10 @@ module Google
1878
1586
  # @return [String]
1879
1587
  attr_accessor :title
1880
1588
 
1881
- # A list of all proto message types included in this API service.
1882
- # Types referenced directly or indirectly by the `apis` are
1883
- # automatically included. Messages which are not referenced but
1884
- # shall be included, such as types used by the `google.protobuf.Any` type,
1885
- # should be listed here by name. Example:
1886
- # types:
1589
+ # A list of all proto message types included in this API service. Types
1590
+ # referenced directly or indirectly by the `apis` are automatically included.
1591
+ # Messages which are not referenced but shall be included, such as types used by
1592
+ # the `google.protobuf.Any` type, should be listed here by name. Example: types:
1887
1593
  # - name: google.protobuf.Int32
1888
1594
  # Corresponds to the JSON property `types`
1889
1595
  # @return [Array<Google::Apis::ServiceusageV1::Type>]
@@ -1930,32 +1636,28 @@ module Google
1930
1636
  end
1931
1637
  end
1932
1638
 
1933
- # The per-product per-project service identity for a service.
1934
- # Use this field to configure per-product per-project service identity.
1935
- # Example of a service identity configuration.
1936
- # usage:
1937
- # service_identity:
1938
- # - service_account_parent: "projects/123456789"
1939
- # display_name: "Cloud XXX Service Agent"
1940
- # description: "Used as the identity of Cloud XXX to access resources"
1639
+ # The per-product per-project service identity for a service. Use this field to
1640
+ # configure per-product per-project service identity. Example of a service
1641
+ # identity configuration. usage: service_identity: - service_account_parent: "
1642
+ # projects/123456789" display_name: "Cloud XXX Service Agent" description: "Used
1643
+ # as the identity of Cloud XXX to access resources"
1941
1644
  class GoogleApiServiceIdentity
1942
1645
  include Google::Apis::Core::Hashable
1943
1646
 
1944
- # Optional. A user-specified opaque description of the service account.
1945
- # Must be less than or equal to 256 UTF-8 bytes.
1647
+ # Optional. A user-specified opaque description of the service account. Must be
1648
+ # less than or equal to 256 UTF-8 bytes.
1946
1649
  # Corresponds to the JSON property `description`
1947
1650
  # @return [String]
1948
1651
  attr_accessor :description
1949
1652
 
1950
- # Optional. A user-specified name for the service account.
1951
- # Must be less than or equal to 100 UTF-8 bytes.
1653
+ # Optional. A user-specified name for the service account. Must be less than or
1654
+ # equal to 100 UTF-8 bytes.
1952
1655
  # Corresponds to the JSON property `displayName`
1953
1656
  # @return [String]
1954
1657
  attr_accessor :display_name
1955
1658
 
1956
- # A service account project that hosts the service accounts.
1957
- # An example name would be:
1958
- # `projects/123456789`
1659
+ # A service account project that hosts the service accounts. An example name
1660
+ # would be: `projects/123456789`
1959
1661
  # Corresponds to the JSON property `serviceAccountParent`
1960
1662
  # @return [String]
1961
1663
  attr_accessor :service_account_parent
@@ -1976,8 +1678,7 @@ module Google
1976
1678
  class GoogleApiServiceusageV1OperationMetadata
1977
1679
  include Google::Apis::Core::Hashable
1978
1680
 
1979
- # The full name of the resources that this operation is directly
1980
- # associated with.
1681
+ # The full name of the resources that this operation is directly associated with.
1981
1682
  # Corresponds to the JSON property `resourceNames`
1982
1683
  # @return [Array<String>]
1983
1684
  attr_accessor :resource_names
@@ -2001,16 +1702,13 @@ module Google
2001
1702
  # @return [Google::Apis::ServiceusageV1::GoogleApiServiceusageV1ServiceConfig]
2002
1703
  attr_accessor :config
2003
1704
 
2004
- # The resource name of the consumer and service.
2005
- # A valid name would be:
2006
- # - projects/123/services/serviceusage.googleapis.com
1705
+ # The resource name of the consumer and service. A valid name would be: -
1706
+ # projects/123/services/serviceusage.googleapis.com
2007
1707
  # Corresponds to the JSON property `name`
2008
1708
  # @return [String]
2009
1709
  attr_accessor :name
2010
1710
 
2011
- # The resource name of the consumer.
2012
- # A valid name would be:
2013
- # - projects/123
1711
+ # The resource name of the consumer. A valid name would be: - projects/123
2014
1712
  # Corresponds to the JSON property `parent`
2015
1713
  # @return [String]
2016
1714
  attr_accessor :parent
@@ -2043,129 +1741,76 @@ module Google
2043
1741
  # @return [Array<Google::Apis::ServiceusageV1::Api>]
2044
1742
  attr_accessor :apis
2045
1743
 
2046
- # `Authentication` defines the authentication configuration for an API.
2047
- # Example for an API targeted for external use:
2048
- # name: calendar.googleapis.com
2049
- # authentication:
2050
- # providers:
2051
- # - id: google_calendar_auth
2052
- # jwks_uri: https://www.googleapis.com/oauth2/v1/certs
2053
- # issuer: https://securetoken.google.com
2054
- # rules:
2055
- # - selector: "*"
2056
- # requirements:
2057
- # provider_id: google_calendar_auth
1744
+ # `Authentication` defines the authentication configuration for an API. Example
1745
+ # for an API targeted for external use: name: calendar.googleapis.com
1746
+ # authentication: providers: - id: google_calendar_auth jwks_uri: https://www.
1747
+ # googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: -
1748
+ # selector: "*" requirements: provider_id: google_calendar_auth
2058
1749
  # Corresponds to the JSON property `authentication`
2059
1750
  # @return [Google::Apis::ServiceusageV1::Authentication]
2060
1751
  attr_accessor :authentication
2061
1752
 
2062
- # `Documentation` provides the information for describing a service.
2063
- # Example:
2064
- # <pre><code>documentation:
2065
- # summary: >
2066
- # The Google Calendar API gives access
2067
- # to most calendar features.
2068
- # pages:
2069
- # - name: Overview
2070
- # content: &#40;== include google/foo/overview.md ==&#41;
2071
- # - name: Tutorial
2072
- # content: &#40;== include google/foo/tutorial.md ==&#41;
2073
- # subpages;
2074
- # - name: Java
2075
- # content: &#40;== include google/foo/tutorial_java.md ==&#41;
2076
- # rules:
2077
- # - selector: google.calendar.Calendar.Get
2078
- # description: >
2079
- # ...
2080
- # - selector: google.calendar.Calendar.Put
2081
- # description: >
2082
- # ...
2083
- # </code></pre>
2084
- # Documentation is provided in markdown syntax. In addition to
2085
- # standard markdown features, definition lists, tables and fenced
2086
- # code blocks are supported. Section headers can be provided and are
2087
- # interpreted relative to the section nesting of the context where
2088
- # a documentation fragment is embedded.
2089
- # Documentation from the IDL is merged with documentation defined
2090
- # via the config at normalization time, where documentation provided
2091
- # by config rules overrides IDL provided.
2092
- # A number of constructs specific to the API platform are supported
2093
- # in documentation text.
2094
- # In order to reference a proto element, the following
2095
- # notation can be used:
2096
- # <pre><code>&#91;fully.qualified.proto.name]&#91;]</code></pre>
2097
- # To override the display text used for the link, this can be used:
2098
- # <pre><code>&#91;display text]&#91;fully.qualified.proto.name]</code></pre>
2099
- # Text can be excluded from doc using the following notation:
2100
- # <pre><code>&#40;-- internal comment --&#41;</code></pre>
2101
- # A few directives are available in documentation. Note that
2102
- # directives must appear on a single line to be properly
2103
- # identified. The `include` directive includes a markdown file from
2104
- # an external source:
2105
- # <pre><code>&#40;== include path/to/file ==&#41;</code></pre>
2106
- # The `resource_for` directive marks a message to be the resource of
2107
- # a collection in REST view. If it is not specified, tools attempt
2108
- # to infer the resource from the operations in a collection:
2109
- # <pre><code>&#40;== resource_for v1.shelves.books ==&#41;</code></pre>
2110
- # The directive `suppress_warning` does not directly affect documentation
2111
- # and is documented together with service config validation.
1753
+ # `Documentation` provides the information for describing a service. Example:
1754
+ # documentation: summary: > The Google Calendar API gives access to most
1755
+ # calendar features. pages: - name: Overview content: (== include google/foo/
1756
+ # overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==
1757
+ # ) subpages; - name: Java content: (== include google/foo/tutorial_java.md ==)
1758
+ # rules: - selector: google.calendar.Calendar.Get description: > ... - selector:
1759
+ # google.calendar.Calendar.Put description: > ... Documentation is provided in
1760
+ # markdown syntax. In addition to standard markdown features, definition lists,
1761
+ # tables and fenced code blocks are supported. Section headers can be provided
1762
+ # and are interpreted relative to the section nesting of the context where a
1763
+ # documentation fragment is embedded. Documentation from the IDL is merged with
1764
+ # documentation defined via the config at normalization time, where
1765
+ # documentation provided by config rules overrides IDL provided. A number of
1766
+ # constructs specific to the API platform are supported in documentation text.
1767
+ # In order to reference a proto element, the following notation can be used: [
1768
+ # fully.qualified.proto.name][] To override the display text used for the link,
1769
+ # this can be used: [display text][fully.qualified.proto.name] Text can be
1770
+ # excluded from doc using the following notation: (-- internal comment --) A few
1771
+ # directives are available in documentation. Note that directives must appear on
1772
+ # a single line to be properly identified. The `include` directive includes a
1773
+ # markdown file from an external source: (== include path/to/file ==) The `
1774
+ # resource_for` directive marks a message to be the resource of a collection in
1775
+ # REST view. If it is not specified, tools attempt to infer the resource from
1776
+ # the operations in a collection: (== resource_for v1.shelves.books ==) The
1777
+ # directive `suppress_warning` does not directly affect documentation and is
1778
+ # documented together with service config validation.
2112
1779
  # Corresponds to the JSON property `documentation`
2113
1780
  # @return [Google::Apis::ServiceusageV1::Documentation]
2114
1781
  attr_accessor :documentation
2115
1782
 
2116
- # Configuration for network endpoints. Contains only the names and aliases
2117
- # of the endpoints.
1783
+ # Configuration for network endpoints. Contains only the names and aliases of
1784
+ # the endpoints.
2118
1785
  # Corresponds to the JSON property `endpoints`
2119
1786
  # @return [Array<Google::Apis::ServiceusageV1::Endpoint>]
2120
1787
  attr_accessor :endpoints
2121
1788
 
2122
- # The DNS address at which this service is available.
2123
- # An example DNS address would be:
2124
- # `calendar.googleapis.com`.
1789
+ # The DNS address at which this service is available. An example DNS address
1790
+ # would be: `calendar.googleapis.com`.
2125
1791
  # Corresponds to the JSON property `name`
2126
1792
  # @return [String]
2127
1793
  attr_accessor :name
2128
1794
 
2129
- # Quota configuration helps to achieve fairness and budgeting in service
2130
- # usage.
2131
- # The metric based quota configuration works this way:
2132
- # - The service configuration defines a set of metrics.
2133
- # - For API calls, the quota.metric_rules maps methods to metrics with
2134
- # corresponding costs.
2135
- # - The quota.limits defines limits on the metrics, which will be used for
2136
- # quota checks at runtime.
2137
- # An example quota configuration in yaml format:
2138
- # quota:
2139
- # limits:
2140
- # - name: apiWriteQpsPerProject
2141
- # metric: library.googleapis.com/write_calls
2142
- # unit: "1/min/`project`" # rate limit for consumer projects
2143
- # values:
2144
- # STANDARD: 10000
2145
- # # The metric rules bind all methods to the read_calls metric,
2146
- # # except for the UpdateBook and DeleteBook methods. These two methods
2147
- # # are mapped to the write_calls metric, with the UpdateBook method
2148
- # # consuming at twice rate as the DeleteBook method.
2149
- # metric_rules:
2150
- # - selector: "*"
2151
- # metric_costs:
2152
- # library.googleapis.com/read_calls: 1
2153
- # - selector: google.example.library.v1.LibraryService.UpdateBook
2154
- # metric_costs:
2155
- # library.googleapis.com/write_calls: 2
2156
- # - selector: google.example.library.v1.LibraryService.DeleteBook
2157
- # metric_costs:
2158
- # library.googleapis.com/write_calls: 1
2159
- # Corresponding Metric definition:
2160
- # metrics:
2161
- # - name: library.googleapis.com/read_calls
2162
- # display_name: Read requests
2163
- # metric_kind: DELTA
2164
- # value_type: INT64
2165
- # - name: library.googleapis.com/write_calls
2166
- # display_name: Write requests
2167
- # metric_kind: DELTA
2168
- # value_type: INT64
1795
+ # Quota configuration helps to achieve fairness and budgeting in service usage.
1796
+ # The metric based quota configuration works this way: - The service
1797
+ # configuration defines a set of metrics. - For API calls, the quota.
1798
+ # metric_rules maps methods to metrics with corresponding costs. - The quota.
1799
+ # limits defines limits on the metrics, which will be used for quota checks at
1800
+ # runtime. An example quota configuration in yaml format: quota: limits: - name:
1801
+ # apiWriteQpsPerProject metric: library.googleapis.com/write_calls unit: "1/min/`
1802
+ # project`" # rate limit for consumer projects values: STANDARD: 10000 # The
1803
+ # metric rules bind all methods to the read_calls metric, # except for the
1804
+ # UpdateBook and DeleteBook methods. These two methods # are mapped to the
1805
+ # write_calls metric, with the UpdateBook method # consuming at twice rate as
1806
+ # the DeleteBook method. metric_rules: - selector: "*" metric_costs: library.
1807
+ # googleapis.com/read_calls: 1 - selector: google.example.library.v1.
1808
+ # LibraryService.UpdateBook metric_costs: library.googleapis.com/write_calls: 2 -
1809
+ # selector: google.example.library.v1.LibraryService.DeleteBook metric_costs:
1810
+ # library.googleapis.com/write_calls: 1 Corresponding Metric definition: metrics:
1811
+ # - name: library.googleapis.com/read_calls display_name: Read requests
1812
+ # metric_kind: DELTA value_type: INT64 - name: library.googleapis.com/
1813
+ # write_calls display_name: Write requests metric_kind: DELTA value_type: INT64
2169
1814
  # Corresponds to the JSON property `quota`
2170
1815
  # @return [Google::Apis::ServiceusageV1::Quota]
2171
1816
  attr_accessor :quota
@@ -2228,15 +1873,14 @@ module Google
2228
1873
  class GoogleApiServiceusageV1beta1ServiceIdentity
2229
1874
  include Google::Apis::Core::Hashable
2230
1875
 
2231
- # The email address of the service account that a service producer would use
2232
- # to access consumer resources.
1876
+ # The email address of the service account that a service producer would use to
1877
+ # access consumer resources.
2233
1878
  # Corresponds to the JSON property `email`
2234
1879
  # @return [String]
2235
1880
  attr_accessor :email
2236
1881
 
2237
- # The unique and stable id of the service account.
2238
- # https://cloud.google.com/iam/reference/rest/v1/projects.serviceAccounts#
2239
- # ServiceAccount
1882
+ # The unique and stable id of the service account. https://cloud.google.com/iam/
1883
+ # reference/rest/v1/projects.serviceAccounts#ServiceAccount
2240
1884
  # Corresponds to the JSON property `uniqueId`
2241
1885
  # @return [String]
2242
1886
  attr_accessor :unique_id
@@ -2253,23 +1897,22 @@ module Google
2253
1897
  end
2254
1898
 
2255
1899
  # Defines the HTTP configuration for an API service. It contains a list of
2256
- # HttpRule, each specifying the mapping of an RPC method
2257
- # to one or more HTTP REST API methods.
1900
+ # HttpRule, each specifying the mapping of an RPC method to one or more HTTP
1901
+ # REST API methods.
2258
1902
  class Http
2259
1903
  include Google::Apis::Core::Hashable
2260
1904
 
2261
1905
  # When set to true, URL path parameters will be fully URI-decoded except in
2262
1906
  # cases of single segment matches in reserved expansion, where "%2F" will be
2263
- # left encoded.
2264
- # The default behavior is to not decode RFC 6570 reserved characters in multi
2265
- # segment matches.
1907
+ # left encoded. The default behavior is to not decode RFC 6570 reserved
1908
+ # characters in multi segment matches.
2266
1909
  # Corresponds to the JSON property `fullyDecodeReservedExpansion`
2267
1910
  # @return [Boolean]
2268
1911
  attr_accessor :fully_decode_reserved_expansion
2269
1912
  alias_method :fully_decode_reserved_expansion?, :fully_decode_reserved_expansion
2270
1913
 
2271
- # A list of HTTP configuration rules that apply to individual API methods.
2272
- # **NOTE:** All service configuration rules follow "last one wins" order.
1914
+ # A list of HTTP configuration rules that apply to individual API methods. **
1915
+ # NOTE:** All service configuration rules follow "last one wins" order.
2273
1916
  # Corresponds to the JSON property `rules`
2274
1917
  # @return [Array<Google::Apis::ServiceusageV1::HttpRule>]
2275
1918
  attr_accessor :rules
@@ -2285,251 +1928,156 @@ module Google
2285
1928
  end
2286
1929
  end
2287
1930
 
2288
- # # gRPC Transcoding
2289
- # gRPC Transcoding is a feature for mapping between a gRPC method and one or
2290
- # more HTTP REST endpoints. It allows developers to build a single API service
2291
- # that supports both gRPC APIs and REST APIs. Many systems, including [Google
2292
- # APIs](https://github.com/googleapis/googleapis),
2293
- # [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC
2294
- # Gateway](https://github.com/grpc-ecosystem/grpc-gateway),
2295
- # and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature
2296
- # and use it for large scale production services.
2297
- # `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies
2298
- # how different portions of the gRPC request message are mapped to the URL
2299
- # path, URL query parameters, and HTTP request body. It also controls how the
2300
- # gRPC response message is mapped to the HTTP response body. `HttpRule` is
1931
+ # # gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC
1932
+ # method and one or more HTTP REST endpoints. It allows developers to build a
1933
+ # single API service that supports both gRPC APIs and REST APIs. Many systems,
1934
+ # including [Google APIs](https://github.com/googleapis/googleapis), [Cloud
1935
+ # Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.
1936
+ # com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/
1937
+ # envoy) proxy support this feature and use it for large scale production
1938
+ # services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping
1939
+ # specifies how different portions of the gRPC request message are mapped to the
1940
+ # URL path, URL query parameters, and HTTP request body. It also controls how
1941
+ # the gRPC response message is mapped to the HTTP response body. `HttpRule` is
2301
1942
  # typically specified as an `google.api.http` annotation on the gRPC method.
2302
1943
  # Each mapping specifies a URL path template and an HTTP method. The path
2303
1944
  # template may refer to one or more fields in the gRPC request message, as long
2304
- # as each field is a non-repeated field with a primitive (non-message) type.
2305
- # The path template controls how fields of the request message are mapped to
2306
- # the URL path.
2307
- # Example:
2308
- # service Messaging `
2309
- # rpc GetMessage(GetMessageRequest) returns (Message) `
2310
- # option (google.api.http) = `
2311
- # get: "/v1/`name=messages/*`"
2312
- # `;
2313
- # `
2314
- # `
2315
- # message GetMessageRequest `
2316
- # string name = 1; // Mapped to URL path.
2317
- # `
2318
- # message Message `
2319
- # string text = 1; // The resource content.
2320
- # `
2321
- # This enables an HTTP REST to gRPC mapping as below:
2322
- # HTTP | gRPC
2323
- # -----|-----
2324
- # `GET /v1/messages/123456` | `GetMessage(name: "messages/123456")`
2325
- # Any fields in the request message which are not bound by the path template
2326
- # automatically become HTTP query parameters if there is no HTTP request body.
2327
- # For example:
2328
- # service Messaging `
2329
- # rpc GetMessage(GetMessageRequest) returns (Message) `
2330
- # option (google.api.http) = `
2331
- # get:"/v1/messages/`message_id`"
2332
- # `;
2333
- # `
2334
- # `
2335
- # message GetMessageRequest `
2336
- # message SubMessage `
2337
- # string subfield = 1;
2338
- # `
2339
- # string message_id = 1; // Mapped to URL path.
2340
- # int64 revision = 2; // Mapped to URL query parameter `revision`.
2341
- # SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`.
2342
- # `
2343
- # This enables a HTTP JSON to RPC mapping as below:
2344
- # HTTP | gRPC
2345
- # -----|-----
2346
- # `GET /v1/messages/123456?revision=2&sub.subfield=foo` |
2347
- # `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield:
2348
- # "foo"))`
2349
- # Note that fields which are mapped to URL query parameters must have a
2350
- # primitive type or a repeated primitive type or a non-repeated message type.
2351
- # In the case of a repeated type, the parameter can be repeated in the URL
2352
- # as `...?param=A&param=B`. In the case of a message type, each field of the
2353
- # message is mapped to a separate parameter, such as
2354
- # `...?foo.a=A&foo.b=B&foo.c=C`.
2355
- # For HTTP methods that allow a request body, the `body` field
2356
- # specifies the mapping. Consider a REST update method on the
2357
- # message resource collection:
2358
- # service Messaging `
2359
- # rpc UpdateMessage(UpdateMessageRequest) returns (Message) `
2360
- # option (google.api.http) = `
2361
- # patch: "/v1/messages/`message_id`"
2362
- # body: "message"
2363
- # `;
2364
- # `
2365
- # `
2366
- # message UpdateMessageRequest `
2367
- # string message_id = 1; // mapped to the URL
2368
- # Message message = 2; // mapped to the body
2369
- # `
2370
- # The following HTTP JSON to RPC mapping is enabled, where the
2371
- # representation of the JSON in the request body is determined by
2372
- # protos JSON encoding:
2373
- # HTTP | gRPC
2374
- # -----|-----
2375
- # `PATCH /v1/messages/123456 ` "text": "Hi!" `` | `UpdateMessage(message_id:
2376
- # "123456" message ` text: "Hi!" `)`
2377
- # The special name `*` can be used in the body mapping to define that
2378
- # every field not bound by the path template should be mapped to the
2379
- # request body. This enables the following alternative definition of
2380
- # the update method:
2381
- # service Messaging `
2382
- # rpc UpdateMessage(Message) returns (Message) `
2383
- # option (google.api.http) = `
2384
- # patch: "/v1/messages/`message_id`"
2385
- # body: "*"
2386
- # `;
2387
- # `
2388
- # `
2389
- # message Message `
2390
- # string message_id = 1;
2391
- # string text = 2;
2392
- # `
2393
- # The following HTTP JSON to RPC mapping is enabled:
2394
- # HTTP | gRPC
2395
- # -----|-----
2396
- # `PATCH /v1/messages/123456 ` "text": "Hi!" `` | `UpdateMessage(message_id:
2397
- # "123456" text: "Hi!")`
2398
- # Note that when using `*` in the body mapping, it is not possible to
2399
- # have HTTP parameters, as all fields not bound by the path end in
2400
- # the body. This makes this option more rarely used in practice when
2401
- # defining REST APIs. The common usage of `*` is in custom methods
2402
- # which don't use the URL at all for transferring data.
2403
- # It is possible to define multiple HTTP methods for one RPC by using
2404
- # the `additional_bindings` option. Example:
2405
- # service Messaging `
2406
- # rpc GetMessage(GetMessageRequest) returns (Message) `
2407
- # option (google.api.http) = `
2408
- # get: "/v1/messages/`message_id`"
2409
- # additional_bindings `
2410
- # get: "/v1/users/`user_id`/messages/`message_id`"
2411
- # `
2412
- # `;
2413
- # `
2414
- # `
2415
- # message GetMessageRequest `
2416
- # string message_id = 1;
2417
- # string user_id = 2;
2418
- # `
2419
- # This enables the following two alternative HTTP JSON to RPC mappings:
2420
- # HTTP | gRPC
2421
- # -----|-----
2422
- # `GET /v1/messages/123456` | `GetMessage(message_id: "123456")`
2423
- # `GET /v1/users/me/messages/123456` | `GetMessage(user_id: "me" message_id:
2424
- # "123456")`
2425
- # ## Rules for HTTP mapping
2426
- # 1. Leaf request fields (recursive expansion nested messages in the request
2427
- # message) are classified into three categories:
2428
- # - Fields referred by the path template. They are passed via the URL path.
2429
- # - Fields referred by the HttpRule.body. They are passed via the HTTP
2430
- # request body.
2431
- # - All other fields are passed via the URL query parameters, and the
2432
- # parameter name is the field path in the request message. A repeated
2433
- # field can be represented as multiple query parameters under the same
2434
- # name.
2435
- # 2. If HttpRule.body is "*", there is no URL query parameter, all fields
2436
- # are passed via URL path and HTTP request body.
2437
- # 3. If HttpRule.body is omitted, there is no HTTP request body, all
2438
- # fields are passed via URL path and URL query parameters.
2439
- # ### Path template syntax
2440
- # Template = "/" Segments [ Verb ] ;
2441
- # Segments = Segment ` "/" Segment ` ;
2442
- # Segment = "*" | "**" | LITERAL | Variable ;
2443
- # Variable = "`" FieldPath [ "=" Segments ] "`" ;
2444
- # FieldPath = IDENT ` "." IDENT ` ;
2445
- # Verb = ":" LITERAL ;
2446
- # The syntax `*` matches a single URL path segment. The syntax `**` matches
2447
- # zero or more URL path segments, which must be the last part of the URL path
2448
- # except the `Verb`.
2449
- # The syntax `Variable` matches part of the URL path as specified by its
2450
- # template. A variable template must not contain other variables. If a variable
2451
- # matches a single path segment, its template may be omitted, e.g. ``var``
2452
- # is equivalent to ``var=*``.
2453
- # The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL`
2454
- # contains any reserved character, such characters should be percent-encoded
2455
- # before the matching.
2456
- # If a variable contains exactly one path segment, such as `"`var`"` or
2457
- # `"`var=*`"`, when such a variable is expanded into a URL path on the client
2458
- # side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The
2459
- # server side does the reverse decoding. Such variables show up in the
2460
- # [Discovery
2461
- # Document](https://developers.google.com/discovery/v1/reference/apis) as
2462
- # ``var``.
2463
- # If a variable contains multiple path segments, such as `"`var=foo/*`"`
2464
- # or `"`var=**`"`, when such a variable is expanded into a URL path on the
2465
- # client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded.
2466
- # The server side does the reverse decoding, except "%2F" and "%2f" are left
2467
- # unchanged. Such variables show up in the
2468
- # [Discovery
2469
- # Document](https://developers.google.com/discovery/v1/reference/apis) as
2470
- # ``+var``.
2471
- # ## Using gRPC API Service Configuration
2472
- # gRPC API Service Configuration (service config) is a configuration language
2473
- # for configuring a gRPC service to become a user-facing product. The
2474
- # service config is simply the YAML representation of the `google.api.Service`
2475
- # proto message.
1945
+ # as each field is a non-repeated field with a primitive (non-message) type. The
1946
+ # path template controls how fields of the request message are mapped to the URL
1947
+ # path. Example: service Messaging ` rpc GetMessage(GetMessageRequest) returns (
1948
+ # Message) ` option (google.api.http) = ` get: "/v1/`name=messages/*`" `; ` `
1949
+ # message GetMessageRequest ` string name = 1; // Mapped to URL path. ` message
1950
+ # Message ` string text = 1; // The resource content. ` This enables an HTTP
1951
+ # REST to gRPC mapping as below: HTTP | gRPC -----|----- `GET /v1/messages/
1952
+ # 123456` | `GetMessage(name: "messages/123456")` Any fields in the request
1953
+ # message which are not bound by the path template automatically become HTTP
1954
+ # query parameters if there is no HTTP request body. For example: service
1955
+ # Messaging ` rpc GetMessage(GetMessageRequest) returns (Message) ` option (
1956
+ # google.api.http) = ` get:"/v1/messages/`message_id`" `; ` ` message
1957
+ # GetMessageRequest ` message SubMessage ` string subfield = 1; ` string
1958
+ # message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL
1959
+ # query parameter `revision`. SubMessage sub = 3; // Mapped to URL query
1960
+ # parameter `sub.subfield`. ` This enables a HTTP JSON to RPC mapping as below:
1961
+ # HTTP | gRPC -----|----- `GET /v1/messages/123456?revision=2&sub.subfield=foo` |
1962
+ # `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: "foo"))
1963
+ # ` Note that fields which are mapped to URL query parameters must have a
1964
+ # primitive type or a repeated primitive type or a non-repeated message type. In
1965
+ # the case of a repeated type, the parameter can be repeated in the URL as `...?
1966
+ # param=A&param=B`. In the case of a message type, each field of the message is
1967
+ # mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For
1968
+ # HTTP methods that allow a request body, the `body` field specifies the mapping.
1969
+ # Consider a REST update method on the message resource collection: service
1970
+ # Messaging ` rpc UpdateMessage(UpdateMessageRequest) returns (Message) ` option
1971
+ # (google.api.http) = ` patch: "/v1/messages/`message_id`" body: "message" `; ` `
1972
+ # message UpdateMessageRequest ` string message_id = 1; // mapped to the URL
1973
+ # Message message = 2; // mapped to the body ` The following HTTP JSON to RPC
1974
+ # mapping is enabled, where the representation of the JSON in the request body
1975
+ # is determined by protos JSON encoding: HTTP | gRPC -----|----- `PATCH /v1/
1976
+ # messages/123456 ` "text": "Hi!" `` | `UpdateMessage(message_id: "123456"
1977
+ # message ` text: "Hi!" `)` The special name `*` can be used in the body mapping
1978
+ # to define that every field not bound by the path template should be mapped to
1979
+ # the request body. This enables the following alternative definition of the
1980
+ # update method: service Messaging ` rpc UpdateMessage(Message) returns (Message)
1981
+ # ` option (google.api.http) = ` patch: "/v1/messages/`message_id`" body: "*" `;
1982
+ # ` ` message Message ` string message_id = 1; string text = 2; ` The following
1983
+ # HTTP JSON to RPC mapping is enabled: HTTP | gRPC -----|----- `PATCH /v1/
1984
+ # messages/123456 ` "text": "Hi!" `` | `UpdateMessage(message_id: "123456" text:
1985
+ # "Hi!")` Note that when using `*` in the body mapping, it is not possible to
1986
+ # have HTTP parameters, as all fields not bound by the path end in the body.
1987
+ # This makes this option more rarely used in practice when defining REST APIs.
1988
+ # The common usage of `*` is in custom methods which don't use the URL at all
1989
+ # for transferring data. It is possible to define multiple HTTP methods for one
1990
+ # RPC by using the `additional_bindings` option. Example: service Messaging `
1991
+ # rpc GetMessage(GetMessageRequest) returns (Message) ` option (google.api.http)
1992
+ # = ` get: "/v1/messages/`message_id`" additional_bindings ` get: "/v1/users/`
1993
+ # user_id`/messages/`message_id`" ` `; ` ` message GetMessageRequest ` string
1994
+ # message_id = 1; string user_id = 2; ` This enables the following two
1995
+ # alternative HTTP JSON to RPC mappings: HTTP | gRPC -----|----- `GET /v1/
1996
+ # messages/123456` | `GetMessage(message_id: "123456")` `GET /v1/users/me/
1997
+ # messages/123456` | `GetMessage(user_id: "me" message_id: "123456")` ## Rules
1998
+ # for HTTP mapping 1. Leaf request fields (recursive expansion nested messages
1999
+ # in the request message) are classified into three categories: - Fields
2000
+ # referred by the path template. They are passed via the URL path. - Fields
2001
+ # referred by the HttpRule.body. They are passed via the HTTP request body. -
2002
+ # All other fields are passed via the URL query parameters, and the parameter
2003
+ # name is the field path in the request message. A repeated field can be
2004
+ # represented as multiple query parameters under the same name. 2. If HttpRule.
2005
+ # body is "*", there is no URL query parameter, all fields are passed via URL
2006
+ # path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP
2007
+ # request body, all fields are passed via URL path and URL query parameters. ###
2008
+ # Path template syntax Template = "/" Segments [ Verb ] ; Segments = Segment ` "/
2009
+ # " Segment ` ; Segment = "*" | "**" | LITERAL | Variable ; Variable = "`"
2010
+ # FieldPath [ "=" Segments ] "`" ; FieldPath = IDENT ` "." IDENT ` ; Verb = ":"
2011
+ # LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**`
2012
+ # matches zero or more URL path segments, which must be the last part of the URL
2013
+ # path except the `Verb`. The syntax `Variable` matches part of the URL path as
2014
+ # specified by its template. A variable template must not contain other
2015
+ # variables. If a variable matches a single path segment, its template may be
2016
+ # omitted, e.g. ``var`` is equivalent to ``var=*``. The syntax `LITERAL` matches
2017
+ # literal text in the URL path. If the `LITERAL` contains any reserved character,
2018
+ # such characters should be percent-encoded before the matching. If a variable
2019
+ # contains exactly one path segment, such as `"`var`"` or `"`var=*`"`, when such
2020
+ # a variable is expanded into a URL path on the client side, all characters
2021
+ # except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse
2022
+ # decoding. Such variables show up in the [Discovery Document](https://
2023
+ # developers.google.com/discovery/v1/reference/apis) as ``var``. If a variable
2024
+ # contains multiple path segments, such as `"`var=foo/*`"` or `"`var=**`"`, when
2025
+ # such a variable is expanded into a URL path on the client side, all characters
2026
+ # except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the
2027
+ # reverse decoding, except "%2F" and "%2f" are left unchanged. Such variables
2028
+ # show up in the [Discovery Document](https://developers.google.com/discovery/v1/
2029
+ # reference/apis) as ``+var``. ## Using gRPC API Service Configuration gRPC API
2030
+ # Service Configuration (service config) is a configuration language for
2031
+ # configuring a gRPC service to become a user-facing product. The service config
2032
+ # is simply the YAML representation of the `google.api.Service` proto message.
2476
2033
  # As an alternative to annotating your proto file, you can configure gRPC
2477
- # transcoding in your service config YAML files. You do this by specifying a
2478
- # `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same
2479
- # effect as the proto annotation. This can be particularly useful if you
2480
- # have a proto that is reused in multiple services. Note that any transcoding
2481
- # specified in the service config will override any matching transcoding
2482
- # configuration in the proto.
2483
- # Example:
2484
- # http:
2485
- # rules:
2486
- # # Selects a gRPC method and applies HttpRule to it.
2487
- # - selector: example.v1.Messaging.GetMessage
2488
- # get: /v1/messages/`message_id`/`sub.subfield`
2489
- # ## Special notes
2490
- # When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the
2491
- # proto to JSON conversion must follow the [proto3
2492
- # specification](https://developers.google.com/protocol-buffers/docs/proto3#json)
2493
- # .
2494
- # While the single segment variable follows the semantics of
2495
- # [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String
2496
- # Expansion, the multi segment variable **does not** follow RFC 6570 Section
2497
- # 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion
2498
- # does not expand special characters like `?` and `#`, which would lead
2499
- # to invalid URLs. As the result, gRPC Transcoding uses a custom encoding
2500
- # for multi segment variables.
2501
- # The path variables **must not** refer to any repeated or mapped field,
2502
- # because client libraries are not capable of handling such variable expansion.
2503
- # The path variables **must not** capture the leading "/" character. The reason
2504
- # is that the most common use case "`var`" does not capture the leading "/"
2505
- # character. For consistency, all path variables must share the same behavior.
2506
- # Repeated message fields must not be mapped to URL query parameters, because
2507
- # no client library can support such complicated mapping.
2508
- # If an API needs to use a JSON array for request or response body, it can map
2509
- # the request or response body to a repeated field. However, some gRPC
2510
- # Transcoding implementations may not support this feature.
2034
+ # transcoding in your service config YAML files. You do this by specifying a `
2035
+ # HttpRule` that maps the gRPC method to a REST endpoint, achieving the same
2036
+ # effect as the proto annotation. This can be particularly useful if you have a
2037
+ # proto that is reused in multiple services. Note that any transcoding specified
2038
+ # in the service config will override any matching transcoding configuration in
2039
+ # the proto. Example: http: rules: # Selects a gRPC method and applies HttpRule
2040
+ # to it. - selector: example.v1.Messaging.GetMessage get: /v1/messages/`
2041
+ # message_id`/`sub.subfield` ## Special notes When gRPC Transcoding is used to
2042
+ # map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow
2043
+ # the [proto3 specification](https://developers.google.com/protocol-buffers/docs/
2044
+ # proto3#json). While the single segment variable follows the semantics of [RFC
2045
+ # 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String
2046
+ # Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.
2047
+ # 3 Reserved Expansion. The reason is that the Reserved Expansion does not
2048
+ # expand special characters like `?` and `#`, which would lead to invalid URLs.
2049
+ # As the result, gRPC Transcoding uses a custom encoding for multi segment
2050
+ # variables. The path variables **must not** refer to any repeated or mapped
2051
+ # field, because client libraries are not capable of handling such variable
2052
+ # expansion. The path variables **must not** capture the leading "/" character.
2053
+ # The reason is that the most common use case "`var`" does not capture the
2054
+ # leading "/" character. For consistency, all path variables must share the same
2055
+ # behavior. Repeated message fields must not be mapped to URL query parameters,
2056
+ # because no client library can support such complicated mapping. If an API
2057
+ # needs to use a JSON array for request or response body, it can map the request
2058
+ # or response body to a repeated field. However, some gRPC Transcoding
2059
+ # implementations may not support this feature.
2511
2060
  class HttpRule
2512
2061
  include Google::Apis::Core::Hashable
2513
2062
 
2514
- # Additional HTTP bindings for the selector. Nested bindings must
2515
- # not contain an `additional_bindings` field themselves (that is,
2516
- # the nesting may only be one level deep).
2063
+ # Additional HTTP bindings for the selector. Nested bindings must not contain an
2064
+ # `additional_bindings` field themselves (that is, the nesting may only be one
2065
+ # level deep).
2517
2066
  # Corresponds to the JSON property `additionalBindings`
2518
2067
  # @return [Array<Google::Apis::ServiceusageV1::HttpRule>]
2519
2068
  attr_accessor :additional_bindings
2520
2069
 
2521
- # When this flag is set to true, HTTP requests will be allowed to invoke a
2522
- # half-duplex streaming method.
2070
+ # When this flag is set to true, HTTP requests will be allowed to invoke a half-
2071
+ # duplex streaming method.
2523
2072
  # Corresponds to the JSON property `allowHalfDuplex`
2524
2073
  # @return [Boolean]
2525
2074
  attr_accessor :allow_half_duplex
2526
2075
  alias_method :allow_half_duplex?, :allow_half_duplex
2527
2076
 
2528
- # The name of the request field whose value is mapped to the HTTP request
2529
- # body, or `*` for mapping all request fields not captured by the path
2530
- # pattern to the HTTP body, or omitted for not having any HTTP request body.
2531
- # NOTE: the referred field must be present at the top-level of the request
2532
- # message type.
2077
+ # The name of the request field whose value is mapped to the HTTP request body,
2078
+ # or `*` for mapping all request fields not captured by the path pattern to the
2079
+ # HTTP body, or omitted for not having any HTTP request body. NOTE: the referred
2080
+ # field must be present at the top-level of the request message type.
2533
2081
  # Corresponds to the JSON property `body`
2534
2082
  # @return [String]
2535
2083
  attr_accessor :body
@@ -2544,8 +2092,7 @@ module Google
2544
2092
  # @return [String]
2545
2093
  attr_accessor :delete
2546
2094
 
2547
- # Maps to HTTP GET. Used for listing and getting information about
2548
- # resources.
2095
+ # Maps to HTTP GET. Used for listing and getting information about resources.
2549
2096
  # Corresponds to the JSON property `get`
2550
2097
  # @return [String]
2551
2098
  attr_accessor :get
@@ -2566,16 +2113,15 @@ module Google
2566
2113
  attr_accessor :put
2567
2114
 
2568
2115
  # Optional. The name of the response field whose value is mapped to the HTTP
2569
- # response body. When omitted, the entire response message will be used
2570
- # as the HTTP response body.
2571
- # NOTE: The referred field must be present at the top-level of the response
2572
- # message type.
2116
+ # response body. When omitted, the entire response message will be used as the
2117
+ # HTTP response body. NOTE: The referred field must be present at the top-level
2118
+ # of the response message type.
2573
2119
  # Corresponds to the JSON property `responseBody`
2574
2120
  # @return [String]
2575
2121
  attr_accessor :response_body
2576
2122
 
2577
- # Selects a method to which this rule applies.
2578
- # Refer to selector for syntax details.
2123
+ # Selects a method to which this rule applies. Refer to selector for syntax
2124
+ # details.
2579
2125
  # Corresponds to the JSON property `selector`
2580
2126
  # @return [String]
2581
2127
  attr_accessor :selector
@@ -2671,13 +2217,12 @@ module Google
2671
2217
  # @return [String]
2672
2218
  attr_accessor :query
2673
2219
 
2674
- # The value prefix. The value format is "value_prefix`token`"
2675
- # Only applies to "in" header type. Must be empty for "in" query type.
2676
- # If not empty, the header value has to match (case sensitive) this prefix.
2677
- # If not matched, JWT will not be extracted. If matched, JWT will be
2678
- # extracted after the prefix is removed.
2679
- # For example, for "Authorization: Bearer `JWT`",
2680
- # value_prefix="Bearer " with a space at the end.
2220
+ # The value prefix. The value format is "value_prefix`token`" Only applies to "
2221
+ # in" header type. Must be empty for "in" query type. If not empty, the header
2222
+ # value has to match (case sensitive) this prefix. If not matched, JWT will not
2223
+ # be extracted. If matched, JWT will be extracted after the prefix is removed.
2224
+ # For example, for "Authorization: Bearer `JWT`", value_prefix="Bearer " with a
2225
+ # space at the end.
2681
2226
  # Corresponds to the JSON property `valuePrefix`
2682
2227
  # @return [String]
2683
2228
  attr_accessor :value_prefix
@@ -2754,8 +2299,7 @@ module Google
2754
2299
  class ListServicesResponse
2755
2300
  include Google::Apis::Core::Hashable
2756
2301
 
2757
- # Token that can be passed to `ListServices` to resume a paginated
2758
- # query.
2302
+ # Token that can be passed to `ListServices` to resume a paginated query.
2759
2303
  # Corresponds to the JSON property `nextPageToken`
2760
2304
  # @return [String]
2761
2305
  attr_accessor :next_page_token
@@ -2776,39 +2320,35 @@ module Google
2776
2320
  end
2777
2321
  end
2778
2322
 
2779
- # A description of a log type. Example in YAML format:
2780
- # - name: library.googleapis.com/activity_history
2781
- # description: The history of borrowing and returning library items.
2782
- # display_name: Activity
2783
- # labels:
2784
- # - key: /customer_id
2323
+ # A description of a log type. Example in YAML format: - name: library.
2324
+ # googleapis.com/activity_history description: The history of borrowing and
2325
+ # returning library items. display_name: Activity labels: - key: /customer_id
2785
2326
  # description: Identifier of a library customer
2786
2327
  class LogDescriptor
2787
2328
  include Google::Apis::Core::Hashable
2788
2329
 
2789
- # A human-readable description of this log. This information appears in
2790
- # the documentation and can contain details.
2330
+ # A human-readable description of this log. This information appears in the
2331
+ # documentation and can contain details.
2791
2332
  # Corresponds to the JSON property `description`
2792
2333
  # @return [String]
2793
2334
  attr_accessor :description
2794
2335
 
2795
- # The human-readable name for this log. This information appears on
2796
- # the user interface and should be concise.
2336
+ # The human-readable name for this log. This information appears on the user
2337
+ # interface and should be concise.
2797
2338
  # Corresponds to the JSON property `displayName`
2798
2339
  # @return [String]
2799
2340
  attr_accessor :display_name
2800
2341
 
2801
- # The set of labels that are available to describe a specific log entry.
2802
- # Runtime requests that contain labels not specified here are
2803
- # considered invalid.
2342
+ # The set of labels that are available to describe a specific log entry. Runtime
2343
+ # requests that contain labels not specified here are considered invalid.
2804
2344
  # Corresponds to the JSON property `labels`
2805
2345
  # @return [Array<Google::Apis::ServiceusageV1::LabelDescriptor>]
2806
2346
  attr_accessor :labels
2807
2347
 
2808
- # The name of the log. It must be less than 512 characters long and can
2809
- # include the following characters: upper- and lower-case alphanumeric
2810
- # characters [A-Za-z0-9], and punctuation characters including
2811
- # slash, underscore, hyphen, period [/_-.].
2348
+ # The name of the log. It must be less than 512 characters long and can include
2349
+ # the following characters: upper- and lower-case alphanumeric characters [A-Za-
2350
+ # z0-9], and punctuation characters including slash, underscore, hyphen, period [
2351
+ # /_-.].
2812
2352
  # Corresponds to the JSON property `name`
2813
2353
  # @return [String]
2814
2354
  attr_accessor :name
@@ -2826,48 +2366,30 @@ module Google
2826
2366
  end
2827
2367
  end
2828
2368
 
2829
- # Logging configuration of the service.
2830
- # The following example shows how to configure logs to be sent to the
2831
- # producer and consumer projects. In the example, the `activity_history`
2832
- # log is sent to both the producer and consumer projects, whereas the
2833
- # `purchase_history` log is only sent to the producer project.
2834
- # monitored_resources:
2835
- # - type: library.googleapis.com/branch
2836
- # labels:
2837
- # - key: /city
2838
- # description: The city where the library branch is located in.
2839
- # - key: /name
2840
- # description: The name of the branch.
2841
- # logs:
2842
- # - name: activity_history
2843
- # labels:
2844
- # - key: /customer_id
2845
- # - name: purchase_history
2846
- # logging:
2847
- # producer_destinations:
2848
- # - monitored_resource: library.googleapis.com/branch
2849
- # logs:
2850
- # - activity_history
2851
- # - purchase_history
2852
- # consumer_destinations:
2853
- # - monitored_resource: library.googleapis.com/branch
2854
- # logs:
2855
- # - activity_history
2369
+ # Logging configuration of the service. The following example shows how to
2370
+ # configure logs to be sent to the producer and consumer projects. In the
2371
+ # example, the `activity_history` log is sent to both the producer and consumer
2372
+ # projects, whereas the `purchase_history` log is only sent to the producer
2373
+ # project. monitored_resources: - type: library.googleapis.com/branch labels: -
2374
+ # key: /city description: The city where the library branch is located in. - key:
2375
+ # /name description: The name of the branch. logs: - name: activity_history
2376
+ # labels: - key: /customer_id - name: purchase_history logging:
2377
+ # producer_destinations: - monitored_resource: library.googleapis.com/branch
2378
+ # logs: - activity_history - purchase_history consumer_destinations: -
2379
+ # monitored_resource: library.googleapis.com/branch logs: - activity_history
2856
2380
  class Logging
2857
2381
  include Google::Apis::Core::Hashable
2858
2382
 
2859
- # Logging configurations for sending logs to the consumer project.
2860
- # There can be multiple consumer destinations, each one must have a
2861
- # different monitored resource type. A log can be used in at most
2862
- # one consumer destination.
2383
+ # Logging configurations for sending logs to the consumer project. There can be
2384
+ # multiple consumer destinations, each one must have a different monitored
2385
+ # resource type. A log can be used in at most one consumer destination.
2863
2386
  # Corresponds to the JSON property `consumerDestinations`
2864
2387
  # @return [Array<Google::Apis::ServiceusageV1::LoggingDestination>]
2865
2388
  attr_accessor :consumer_destinations
2866
2389
 
2867
- # Logging configurations for sending logs to the producer project.
2868
- # There can be multiple producer destinations, each one must have a
2869
- # different monitored resource type. A log can be used in at most
2870
- # one producer destination.
2390
+ # Logging configurations for sending logs to the producer project. There can be
2391
+ # multiple producer destinations, each one must have a different monitored
2392
+ # resource type. A log can be used in at most one producer destination.
2871
2393
  # Corresponds to the JSON property `producerDestinations`
2872
2394
  # @return [Array<Google::Apis::ServiceusageV1::LoggingDestination>]
2873
2395
  attr_accessor :producer_destinations
@@ -2883,21 +2405,20 @@ module Google
2883
2405
  end
2884
2406
  end
2885
2407
 
2886
- # Configuration of a specific logging destination (the producer project
2887
- # or the consumer project).
2408
+ # Configuration of a specific logging destination (the producer project or the
2409
+ # consumer project).
2888
2410
  class LoggingDestination
2889
2411
  include Google::Apis::Core::Hashable
2890
2412
 
2891
- # Names of the logs to be sent to this destination. Each name must
2892
- # be defined in the Service.logs section. If the log name is
2893
- # not a domain scoped name, it will be automatically prefixed with
2894
- # the service name followed by "/".
2413
+ # Names of the logs to be sent to this destination. Each name must be defined in
2414
+ # the Service.logs section. If the log name is not a domain scoped name, it will
2415
+ # be automatically prefixed with the service name followed by "/".
2895
2416
  # Corresponds to the JSON property `logs`
2896
2417
  # @return [Array<String>]
2897
2418
  attr_accessor :logs
2898
2419
 
2899
- # The monitored resource type. The type must be defined in the
2900
- # Service.monitored_resources section.
2420
+ # The monitored resource type. The type must be defined in the Service.
2421
+ # monitored_resources section.
2901
2422
  # Corresponds to the JSON property `monitoredResource`
2902
2423
  # @return [String]
2903
2424
  attr_accessor :monitored_resource
@@ -2972,16 +2493,13 @@ module Google
2972
2493
 
2973
2494
  # Defines a metric type and its schema. Once a metric descriptor is created,
2974
2495
  # deleting or altering it stops data collection and makes the metric type's
2975
- # existing data unusable.
2976
- # The following are specific rules for service defined Monitoring metric
2977
- # descriptors:
2978
- # * `type`, `metric_kind`, `value_type` and `description`
2979
- # fields are all required. The `unit` field must be specified
2980
- # if the `value_type` is any of DOUBLE, INT64, DISTRIBUTION.
2981
- # * Maximum of default 500 metric descriptors per service is allowed.
2982
- # * Maximum of default 10 labels per metric descriptor is allowed.
2983
- # The default maximum limit can be overridden. Please follow
2984
- # https://cloud.google.com/monitoring/quotas
2496
+ # existing data unusable. The following are specific rules for service defined
2497
+ # Monitoring metric descriptors: * `type`, `metric_kind`, `value_type` and `
2498
+ # description` fields are all required. The `unit` field must be specified if
2499
+ # the `value_type` is any of DOUBLE, INT64, DISTRIBUTION. * Maximum of default
2500
+ # 500 metric descriptors per service is allowed. * Maximum of default 10 labels
2501
+ # per metric descriptor is allowed. The default maximum limit can be overridden.
2502
+ # Please follow https://cloud.google.com/monitoring/quotas
2985
2503
  class MetricDescriptor
2986
2504
  include Google::Apis::Core::Hashable
2987
2505
 
@@ -2990,26 +2508,21 @@ module Google
2990
2508
  # @return [String]
2991
2509
  attr_accessor :description
2992
2510
 
2993
- # A concise name for the metric, which can be displayed in user interfaces.
2994
- # Use sentence case without an ending period, for example "Request count".
2995
- # This field is optional but it is recommended to be set for any metrics
2996
- # associated with user-visible concepts, such as Quota.
2511
+ # A concise name for the metric, which can be displayed in user interfaces. Use
2512
+ # sentence case without an ending period, for example "Request count". This
2513
+ # field is optional but it is recommended to be set for any metrics associated
2514
+ # with user-visible concepts, such as Quota.
2997
2515
  # Corresponds to the JSON property `displayName`
2998
2516
  # @return [String]
2999
2517
  attr_accessor :display_name
3000
2518
 
3001
- # The set of labels that can be used to describe a specific
3002
- # instance of this metric type.
3003
- # The label key name must follow:
3004
- # * Only upper and lower-case letters, digits and underscores (_) are
3005
- # allowed.
3006
- # * Label name must start with a letter or digit.
3007
- # * The maximum length of a label name is 100 characters.
3008
- # For example, the
3009
- # `appengine.googleapis.com/http/server/response_latencies` metric
3010
- # type has a label for the HTTP response code, `response_code`, so
3011
- # you can look at latencies for successful responses or just
3012
- # for responses that failed.
2519
+ # The set of labels that can be used to describe a specific instance of this
2520
+ # metric type. The label key name must follow: * Only upper and lower-case
2521
+ # letters, digits and underscores (_) are allowed. * Label name must start with
2522
+ # a letter or digit. * The maximum length of a label name is 100 characters. For
2523
+ # example, the `appengine.googleapis.com/http/server/response_latencies` metric
2524
+ # type has a label for the HTTP response code, `response_code`, so you can look
2525
+ # at latencies for successful responses or just for responses that failed.
3013
2526
  # Corresponds to the JSON property `labels`
3014
2527
  # @return [Array<Google::Apis::ServiceusageV1::LabelDescriptor>]
3015
2528
  attr_accessor :labels
@@ -3024,17 +2537,16 @@ module Google
3024
2537
  # @return [Google::Apis::ServiceusageV1::MetricDescriptorMetadata]
3025
2538
  attr_accessor :metadata
3026
2539
 
3027
- # Whether the metric records instantaneous values, changes to a value, etc.
3028
- # Some combinations of `metric_kind` and `value_type` might not be supported.
2540
+ # Whether the metric records instantaneous values, changes to a value, etc. Some
2541
+ # combinations of `metric_kind` and `value_type` might not be supported.
3029
2542
  # Corresponds to the JSON property `metricKind`
3030
2543
  # @return [String]
3031
2544
  attr_accessor :metric_kind
3032
2545
 
3033
- # Read-only. If present, then a time
3034
- # series, which is identified partially by
3035
- # a metric type and a MonitoredResourceDescriptor, that is associated
3036
- # with this metric type can only be associated with one of the monitored
3037
- # resource types listed here.
2546
+ # Read-only. If present, then a time series, which is identified partially by a
2547
+ # metric type and a MonitoredResourceDescriptor, that is associated with this
2548
+ # metric type can only be associated with one of the monitored resource types
2549
+ # listed here.
3038
2550
  # Corresponds to the JSON property `monitoredResourceTypes`
3039
2551
  # @return [Array<String>]
3040
2552
  attr_accessor :monitored_resource_types
@@ -3044,116 +2556,73 @@ module Google
3044
2556
  # @return [String]
3045
2557
  attr_accessor :name
3046
2558
 
3047
- # The metric type, including its DNS name prefix. The type is not
3048
- # URL-encoded.
2559
+ # The metric type, including its DNS name prefix. The type is not URL-encoded.
3049
2560
  # All service defined metrics must be prefixed with the service name, in the
3050
- # format of ``service name`/`relative metric name``, such as
3051
- # `cloudsql.googleapis.com/database/cpu/utilization`. The relative metric
3052
- # name must follow:
2561
+ # format of ``service name`/`relative metric name``, such as `cloudsql.
2562
+ # googleapis.com/database/cpu/utilization`. The relative metric name must follow:
3053
2563
  # * Only upper and lower-case letters, digits, '/' and underscores '_' are
3054
- # allowed.
3055
- # * The maximum number of characters allowed for the relative_metric_name is
3056
- # 100.
3057
- # All user-defined metric types have the DNS name
3058
- # `custom.googleapis.com`, `external.googleapis.com`, or
3059
- # `logging.googleapis.com/user/`.
3060
- # Metric types should use a natural hierarchical grouping. For example:
3061
- # "custom.googleapis.com/invoice/paid/amount"
3062
- # "external.googleapis.com/prometheus/up"
3063
- # "appengine.googleapis.com/http/server/response_latencies"
2564
+ # allowed. * The maximum number of characters allowed for the
2565
+ # relative_metric_name is 100. All user-defined metric types have the DNS name `
2566
+ # custom.googleapis.com`, `external.googleapis.com`, or `logging.googleapis.com/
2567
+ # user/`. Metric types should use a natural hierarchical grouping. For example: "
2568
+ # custom.googleapis.com/invoice/paid/amount" "external.googleapis.com/prometheus/
2569
+ # up" "appengine.googleapis.com/http/server/response_latencies"
3064
2570
  # Corresponds to the JSON property `type`
3065
2571
  # @return [String]
3066
2572
  attr_accessor :type
3067
2573
 
3068
- # The units in which the metric value is reported. It is only applicable
3069
- # if the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The `unit`
3070
- # defines the representation of the stored metric values.
3071
- # Different systems may scale the values to be more easily displayed (so a
3072
- # value of `0.02KBy` _might_ be displayed as `20By`, and a value of
3073
- # `3523KBy` _might_ be displayed as `3.5MBy`). However, if the `unit` is
3074
- # `KBy`, then the value of the metric is always in thousands of bytes, no
3075
- # matter how it may be displayed..
3076
- # If you want a custom metric to record the exact number of CPU-seconds used
3077
- # by a job, you can create an `INT64 CUMULATIVE` metric whose `unit` is
3078
- # `s`CPU`` (or equivalently `1s`CPU`` or just `s`). If the job uses 12,005
3079
- # CPU-seconds, then the value is written as `12005`.
3080
- # Alternatively, if you want a custom metric to record data in a more
3081
- # granular way, you can create a `DOUBLE CUMULATIVE` metric whose `unit` is
3082
- # `ks`CPU``, and then write the value `12.005` (which is `12005/1000`),
3083
- # or use `Kis`CPU`` and write `11.723` (which is `12005/1024`).
3084
- # The supported units are a subset of [The Unified Code for Units of
3085
- # Measure](http://unitsofmeasure.org/ucum.html) standard:
3086
- # **Basic units (UNIT)**
3087
- # * `bit` bit
3088
- # * `By` byte
3089
- # * `s` second
3090
- # * `min` minute
3091
- # * `h` hour
3092
- # * `d` day
3093
- # * `1` dimensionless
3094
- # **Prefixes (PREFIX)**
3095
- # * `k` kilo (10^3)
3096
- # * `M` mega (10^6)
3097
- # * `G` giga (10^9)
3098
- # * `T` tera (10^12)
3099
- # * `P` peta (10^15)
3100
- # * `E` exa (10^18)
3101
- # * `Z` zetta (10^21)
3102
- # * `Y` yotta (10^24)
3103
- # * `m` milli (10^-3)
3104
- # * `u` micro (10^-6)
3105
- # * `n` nano (10^-9)
3106
- # * `p` pico (10^-12)
3107
- # * `f` femto (10^-15)
3108
- # * `a` atto (10^-18)
3109
- # * `z` zepto (10^-21)
3110
- # * `y` yocto (10^-24)
3111
- # * `Ki` kibi (2^10)
3112
- # * `Mi` mebi (2^20)
3113
- # * `Gi` gibi (2^30)
3114
- # * `Ti` tebi (2^40)
3115
- # * `Pi` pebi (2^50)
3116
- # **Grammar**
3117
- # The grammar also includes these connectors:
3118
- # * `/` division or ratio (as an infix operator). For examples,
3119
- # `kBy/`email`` or `MiBy/10ms` (although you should almost never
3120
- # have `/s` in a metric `unit`; rates should always be computed at
3121
- # query time from the underlying cumulative or delta value).
3122
- # * `.` multiplication or composition (as an infix operator). For
3123
- # examples, `GBy.d` or `k`watt`.h`.
3124
- # The grammar for a unit is as follows:
3125
- # Expression = Component ` "." Component ` ` "/" Component ` ;
3126
- # Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ]
3127
- # | Annotation
3128
- # | "1"
3129
- # ;
3130
- # Annotation = "`" NAME "`" ;
3131
- # Notes:
3132
- # * `Annotation` is just a comment if it follows a `UNIT`. If the annotation
3133
- # is used alone, then the unit is equivalent to `1`. For examples,
3134
- # ``request`/s == 1/s`, `By`transmitted`/s == By/s`.
3135
- # * `NAME` is a sequence of non-blank printable ASCII characters not
3136
- # containing ``` or ```.
3137
- # * `1` represents a unitary [dimensionless
3138
- # unit](https://en.wikipedia.org/wiki/Dimensionless_quantity) of 1, such
3139
- # as in `1/s`. It is typically used when none of the basic units are
3140
- # appropriate. For example, "new users per day" can be represented as
3141
- # `1/d` or ``new-users`/d` (and a metric value `5` would mean "5 new
3142
- # users). Alternatively, "thousands of page views per day" would be
3143
- # represented as `1000/d` or `k1/d` or `k`page_views`/d` (and a metric
3144
- # value of `5.3` would mean "5300 page views per day").
3145
- # * `%` represents dimensionless value of 1/100, and annotates values giving
3146
- # a percentage (so the metric values are typically in the range of 0..100,
3147
- # and a metric value `3` means "3 percent").
3148
- # * `10^2.%` indicates a metric contains a ratio, typically in the range
3149
- # 0..1, that will be multiplied by 100 and displayed as a percentage
3150
- # (so a metric value `0.03` means "3 percent").
2574
+ # The units in which the metric value is reported. It is only applicable if the `
2575
+ # value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The `unit` defines the
2576
+ # representation of the stored metric values. Different systems may scale the
2577
+ # values to be more easily displayed (so a value of `0.02KBy` _might_ be
2578
+ # displayed as `20By`, and a value of `3523KBy` _might_ be displayed as `3.5MBy`)
2579
+ # . However, if the `unit` is `KBy`, then the value of the metric is always in
2580
+ # thousands of bytes, no matter how it may be displayed.. If you want a custom
2581
+ # metric to record the exact number of CPU-seconds used by a job, you can create
2582
+ # an `INT64 CUMULATIVE` metric whose `unit` is `s`CPU`` (or equivalently `1s`CPU`
2583
+ # ` or just `s`). If the job uses 12,005 CPU-seconds, then the value is written
2584
+ # as `12005`. Alternatively, if you want a custom metric to record data in a
2585
+ # more granular way, you can create a `DOUBLE CUMULATIVE` metric whose `unit` is
2586
+ # `ks`CPU``, and then write the value `12.005` (which is `12005/1000`), or use `
2587
+ # Kis`CPU`` and write `11.723` (which is `12005/1024`). The supported units are
2588
+ # a subset of [The Unified Code for Units of Measure](http://unitsofmeasure.org/
2589
+ # ucum.html) standard: **Basic units (UNIT)** * `bit` bit * `By` byte * `s`
2590
+ # second * `min` minute * `h` hour * `d` day * `1` dimensionless **Prefixes (
2591
+ # PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga (10^9) * `T` tera (10^
2592
+ # 12) * `P` peta (10^15) * `E` exa (10^18) * `Z` zetta (10^21) * `Y` yotta (10^
2593
+ # 24) * `m` milli (10^-3) * `u` micro (10^-6) * `n` nano (10^-9) * `p` pico (10^-
2594
+ # 12) * `f` femto (10^-15) * `a` atto (10^-18) * `z` zepto (10^-21) * `y` yocto (
2595
+ # 10^-24) * `Ki` kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (
2596
+ # 2^40) * `Pi` pebi (2^50) **Grammar** The grammar also includes these
2597
+ # connectors: * `/` division or ratio (as an infix operator). For examples, `kBy/
2598
+ # `email`` or `MiBy/10ms` (although you should almost never have `/s` in a
2599
+ # metric `unit`; rates should always be computed at query time from the
2600
+ # underlying cumulative or delta value). * `.` multiplication or composition (as
2601
+ # an infix operator). For examples, `GBy.d` or `k`watt`.h`. The grammar for a
2602
+ # unit is as follows: Expression = Component ` "." Component ` ` "/" Component `
2603
+ # ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ;
2604
+ # Annotation = "`" NAME "`" ; Notes: * `Annotation` is just a comment if it
2605
+ # follows a `UNIT`. If the annotation is used alone, then the unit is equivalent
2606
+ # to `1`. For examples, ``request`/s == 1/s`, `By`transmitted`/s == By/s`. * `
2607
+ # NAME` is a sequence of non-blank printable ASCII characters not containing ```
2608
+ # or ```. * `1` represents a unitary [dimensionless unit](https://en.wikipedia.
2609
+ # org/wiki/Dimensionless_quantity) of 1, such as in `1/s`. It is typically used
2610
+ # when none of the basic units are appropriate. For example, "new users per day"
2611
+ # can be represented as `1/d` or ``new-users`/d` (and a metric value `5` would
2612
+ # mean "5 new users). Alternatively, "thousands of page views per day" would be
2613
+ # represented as `1000/d` or `k1/d` or `k`page_views`/d` (and a metric value of `
2614
+ # 5.3` would mean "5300 page views per day"). * `%` represents dimensionless
2615
+ # value of 1/100, and annotates values giving a percentage (so the metric values
2616
+ # are typically in the range of 0..100, and a metric value `3` means "3 percent")
2617
+ # . * `10^2.%` indicates a metric contains a ratio, typically in the range 0..1,
2618
+ # that will be multiplied by 100 and displayed as a percentage (so a metric
2619
+ # value `0.03` means "3 percent").
3151
2620
  # Corresponds to the JSON property `unit`
3152
2621
  # @return [String]
3153
2622
  attr_accessor :unit
3154
2623
 
3155
- # Whether the measurement is an integer, a floating-point number, etc.
3156
- # Some combinations of `metric_kind` and `value_type` might not be supported.
2624
+ # Whether the measurement is an integer, a floating-point number, etc. Some
2625
+ # combinations of `metric_kind` and `value_type` might not be supported.
3157
2626
  # Corresponds to the JSON property `valueType`
3158
2627
  # @return [String]
3159
2628
  attr_accessor :value_type
@@ -3182,9 +2651,9 @@ module Google
3182
2651
  class MetricDescriptorMetadata
3183
2652
  include Google::Apis::Core::Hashable
3184
2653
 
3185
- # The delay of data points caused by ingestion. Data points older than this
3186
- # age are guaranteed to be ingested and available to be read, excluding
3187
- # data loss due to errors.
2654
+ # The delay of data points caused by ingestion. Data points older than this age
2655
+ # are guaranteed to be ingested and available to be read, excluding data loss
2656
+ # due to errors.
3188
2657
  # Corresponds to the JSON property `ingestDelay`
3189
2658
  # @return [String]
3190
2659
  attr_accessor :ingest_delay
@@ -3196,8 +2665,8 @@ module Google
3196
2665
 
3197
2666
  # The sampling period of metric data points. For metrics which are written
3198
2667
  # periodically, consecutive data points are stored at this time interval,
3199
- # excluding data loss due to errors. Metrics with a higher granularity have
3200
- # a smaller sampling period.
2668
+ # excluding data loss due to errors. Metrics with a higher granularity have a
2669
+ # smaller sampling period.
3201
2670
  # Corresponds to the JSON property `samplePeriod`
3202
2671
  # @return [String]
3203
2672
  attr_accessor :sample_period
@@ -3214,22 +2683,21 @@ module Google
3214
2683
  end
3215
2684
  end
3216
2685
 
3217
- # Bind API methods to metrics. Binding a method to a metric causes that
3218
- # metric's configured quota behaviors to apply to the method call.
2686
+ # Bind API methods to metrics. Binding a method to a metric causes that metric's
2687
+ # configured quota behaviors to apply to the method call.
3219
2688
  class MetricRule
3220
2689
  include Google::Apis::Core::Hashable
3221
2690
 
3222
2691
  # Metrics to update when the selected methods are called, and the associated
3223
- # cost applied to each metric.
3224
- # The key of the map is the metric name, and the values are the amount
3225
- # increased for the metric against which the quota limits are defined.
3226
- # The value must not be negative.
2692
+ # cost applied to each metric. The key of the map is the metric name, and the
2693
+ # values are the amount increased for the metric against which the quota limits
2694
+ # are defined. The value must not be negative.
3227
2695
  # Corresponds to the JSON property `metricCosts`
3228
2696
  # @return [Hash<String,Fixnum>]
3229
2697
  attr_accessor :metric_costs
3230
2698
 
3231
- # Selects the methods to which this rule applies.
3232
- # Refer to selector for syntax details.
2699
+ # Selects the methods to which this rule applies. Refer to selector for syntax
2700
+ # details.
3233
2701
  # Corresponds to the JSON property `selector`
3234
2702
  # @return [String]
3235
2703
  attr_accessor :selector
@@ -3247,66 +2715,33 @@ module Google
3247
2715
 
3248
2716
  # Declares an API Interface to be included in this interface. The including
3249
2717
  # interface must redeclare all the methods from the included interface, but
3250
- # documentation and options are inherited as follows:
3251
- # - If after comment and whitespace stripping, the documentation
3252
- # string of the redeclared method is empty, it will be inherited
3253
- # from the original method.
3254
- # - Each annotation belonging to the service config (http,
3255
- # visibility) which is not set in the redeclared method will be
3256
- # inherited.
3257
- # - If an http annotation is inherited, the path pattern will be
3258
- # modified as follows. Any version prefix will be replaced by the
3259
- # version of the including interface plus the root path if
3260
- # specified.
3261
- # Example of a simple mixin:
3262
- # package google.acl.v1;
3263
- # service AccessControl `
3264
- # // Get the underlying ACL object.
3265
- # rpc GetAcl(GetAclRequest) returns (Acl) `
3266
- # option (google.api.http).get = "/v1/`resource=**`:getAcl";
3267
- # `
3268
- # `
3269
- # package google.storage.v2;
3270
- # service Storage `
3271
- # // rpc GetAcl(GetAclRequest) returns (Acl);
3272
- # // Get a data record.
3273
- # rpc GetData(GetDataRequest) returns (Data) `
3274
- # option (google.api.http).get = "/v2/`resource=**`";
3275
- # `
3276
- # `
3277
- # Example of a mixin configuration:
3278
- # apis:
3279
- # - name: google.storage.v2.Storage
3280
- # mixins:
3281
- # - name: google.acl.v1.AccessControl
3282
- # The mixin construct implies that all methods in `AccessControl` are
3283
- # also declared with same name and request/response types in
3284
- # `Storage`. A documentation generator or annotation processor will
3285
- # see the effective `Storage.GetAcl` method after inherting
3286
- # documentation and annotations as follows:
3287
- # service Storage `
3288
- # // Get the underlying ACL object.
3289
- # rpc GetAcl(GetAclRequest) returns (Acl) `
3290
- # option (google.api.http).get = "/v2/`resource=**`:getAcl";
3291
- # `
3292
- # ...
3293
- # `
3294
- # Note how the version in the path pattern changed from `v1` to `v2`.
3295
- # If the `root` field in the mixin is specified, it should be a
3296
- # relative path under which inherited HTTP paths are placed. Example:
3297
- # apis:
3298
- # - name: google.storage.v2.Storage
3299
- # mixins:
3300
- # - name: google.acl.v1.AccessControl
3301
- # root: acls
3302
- # This implies the following inherited HTTP annotation:
3303
- # service Storage `
3304
- # // Get the underlying ACL object.
3305
- # rpc GetAcl(GetAclRequest) returns (Acl) `
3306
- # option (google.api.http).get = "/v2/acls/`resource=**`:getAcl";
3307
- # `
3308
- # ...
3309
- # `
2718
+ # documentation and options are inherited as follows: - If after comment and
2719
+ # whitespace stripping, the documentation string of the redeclared method is
2720
+ # empty, it will be inherited from the original method. - Each annotation
2721
+ # belonging to the service config (http, visibility) which is not set in the
2722
+ # redeclared method will be inherited. - If an http annotation is inherited, the
2723
+ # path pattern will be modified as follows. Any version prefix will be replaced
2724
+ # by the version of the including interface plus the root path if specified.
2725
+ # Example of a simple mixin: package google.acl.v1; service AccessControl ` //
2726
+ # Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) `
2727
+ # option (google.api.http).get = "/v1/`resource=**`:getAcl"; ` ` package google.
2728
+ # storage.v2; service Storage ` // rpc GetAcl(GetAclRequest) returns (Acl); //
2729
+ # Get a data record. rpc GetData(GetDataRequest) returns (Data) ` option (google.
2730
+ # api.http).get = "/v2/`resource=**`"; ` ` Example of a mixin configuration:
2731
+ # apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.
2732
+ # AccessControl The mixin construct implies that all methods in `AccessControl`
2733
+ # are also declared with same name and request/response types in `Storage`. A
2734
+ # documentation generator or annotation processor will see the effective `
2735
+ # Storage.GetAcl` method after inherting documentation and annotations as
2736
+ # follows: service Storage ` // Get the underlying ACL object. rpc GetAcl(
2737
+ # GetAclRequest) returns (Acl) ` option (google.api.http).get = "/v2/`resource=**
2738
+ # `:getAcl"; ` ... ` Note how the version in the path pattern changed from `v1`
2739
+ # to `v2`. If the `root` field in the mixin is specified, it should be a
2740
+ # relative path under which inherited HTTP paths are placed. Example: apis: -
2741
+ # name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl
2742
+ # root: acls This implies the following inherited HTTP annotation: service
2743
+ # Storage ` // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (
2744
+ # Acl) ` option (google.api.http).get = "/v2/acls/`resource=**`:getAcl"; ` ... `
3310
2745
  class Mixin
3311
2746
  include Google::Apis::Core::Hashable
3312
2747
 
@@ -3315,8 +2750,7 @@ module Google
3315
2750
  # @return [String]
3316
2751
  attr_accessor :name
3317
2752
 
3318
- # If non-empty specifies a path under which inherited HTTP paths
3319
- # are rooted.
2753
+ # If non-empty specifies a path under which inherited HTTP paths are rooted.
3320
2754
  # Corresponds to the JSON property `root`
3321
2755
  # @return [String]
3322
2756
  attr_accessor :root
@@ -3332,51 +2766,42 @@ module Google
3332
2766
  end
3333
2767
  end
3334
2768
 
3335
- # An object that describes the schema of a MonitoredResource object using a
3336
- # type name and a set of labels. For example, the monitored resource
3337
- # descriptor for Google Compute Engine VM instances has a type of
3338
- # `"gce_instance"` and specifies the use of the labels `"instance_id"` and
3339
- # `"zone"` to identify particular VM instances.
3340
- # Different services can support different monitored resource types.
3341
- # The following are specific rules to service defined monitored resources for
3342
- # Monitoring and Logging:
3343
- # * The `type`, `display_name`, `description`, `labels` and `launch_stage`
3344
- # fields are all required.
3345
- # * The first label of the monitored resource descriptor must be
3346
- # `resource_container`. There are legacy monitored resource descritptors
3347
- # start with `project_id`.
3348
- # * It must include a `location` label.
3349
- # * Maximum of default 5 service defined monitored resource descriptors
3350
- # is allowed per service.
3351
- # * Maximum of default 10 labels per monitored resource is allowed.
3352
- # The default maximum limit can be overridden. Please follow
3353
- # https://cloud.google.com/monitoring/quotas
2769
+ # An object that describes the schema of a MonitoredResource object using a type
2770
+ # name and a set of labels. For example, the monitored resource descriptor for
2771
+ # Google Compute Engine VM instances has a type of `"gce_instance"` and
2772
+ # specifies the use of the labels `"instance_id"` and `"zone"` to identify
2773
+ # particular VM instances. Different services can support different monitored
2774
+ # resource types. The following are specific rules to service defined monitored
2775
+ # resources for Monitoring and Logging: * The `type`, `display_name`, `
2776
+ # description`, `labels` and `launch_stage` fields are all required. * The first
2777
+ # label of the monitored resource descriptor must be `resource_container`. There
2778
+ # are legacy monitored resource descritptors start with `project_id`. * It must
2779
+ # include a `location` label. * Maximum of default 5 service defined monitored
2780
+ # resource descriptors is allowed per service. * Maximum of default 10 labels
2781
+ # per monitored resource is allowed. The default maximum limit can be overridden.
2782
+ # Please follow https://cloud.google.com/monitoring/quotas
3354
2783
  class MonitoredResourceDescriptor
3355
2784
  include Google::Apis::Core::Hashable
3356
2785
 
3357
- # Optional. A detailed description of the monitored resource type that might
3358
- # be used in documentation.
2786
+ # Optional. A detailed description of the monitored resource type that might be
2787
+ # used in documentation.
3359
2788
  # Corresponds to the JSON property `description`
3360
2789
  # @return [String]
3361
2790
  attr_accessor :description
3362
2791
 
3363
2792
  # Optional. A concise name for the monitored resource type that might be
3364
- # displayed in user interfaces. It should be a Title Cased Noun Phrase,
3365
- # without any article or other determiners. For example,
3366
- # `"Google Cloud SQL Database"`.
2793
+ # displayed in user interfaces. It should be a Title Cased Noun Phrase, without
2794
+ # any article or other determiners. For example, `"Google Cloud SQL Database"`.
3367
2795
  # Corresponds to the JSON property `displayName`
3368
2796
  # @return [String]
3369
2797
  attr_accessor :display_name
3370
2798
 
3371
2799
  # Required. A set of labels used to describe instances of this monitored
3372
- # resource type.
3373
- # The label key name must follow:
3374
- # * Only upper and lower-case letters, digits and underscores (_) are
3375
- # allowed.
3376
- # * Label name must start with a letter or digit.
3377
- # * The maximum length of a label name is 100 characters.
3378
- # For example, an individual Google Cloud SQL database is
3379
- # identified by values for the labels `database_id` and `location`.
2800
+ # resource type. The label key name must follow: * Only upper and lower-case
2801
+ # letters, digits and underscores (_) are allowed. * Label name must start with
2802
+ # a letter or digit. * The maximum length of a label name is 100 characters. For
2803
+ # example, an individual Google Cloud SQL database is identified by values for
2804
+ # the labels `database_id` and `location`.
3380
2805
  # Corresponds to the JSON property `labels`
3381
2806
  # @return [Array<Google::Apis::ServiceusageV1::LabelDescriptor>]
3382
2807
  attr_accessor :labels
@@ -3386,27 +2811,25 @@ module Google
3386
2811
  # @return [String]
3387
2812
  attr_accessor :launch_stage
3388
2813
 
3389
- # Optional. The resource name of the monitored resource descriptor:
3390
- # `"projects/`project_id`/monitoredResourceDescriptors/`type`"` where
3391
- # `type` is the value of the `type` field in this object and
3392
- # `project_id` is a project ID that provides API-specific context for
3393
- # accessing the type. APIs that do not use project information can use the
3394
- # resource name format `"monitoredResourceDescriptors/`type`"`.
2814
+ # Optional. The resource name of the monitored resource descriptor: `"projects/`
2815
+ # project_id`/monitoredResourceDescriptors/`type`"` where `type` is the value of
2816
+ # the `type` field in this object and `project_id` is a project ID that provides
2817
+ # API-specific context for accessing the type. APIs that do not use project
2818
+ # information can use the resource name format `"monitoredResourceDescriptors/`
2819
+ # type`"`.
3395
2820
  # Corresponds to the JSON property `name`
3396
2821
  # @return [String]
3397
2822
  attr_accessor :name
3398
2823
 
3399
- # Required. The monitored resource type. For example, the type
3400
- # `cloudsql_database` represents databases in Google Cloud SQL.
3401
- # All service defined monitored resource types must be prefixed with the
3402
- # service name, in the format of ``service name`/`relative resource name``.
3403
- # The relative resource name must follow:
3404
- # * Only upper and lower-case letters and digits are allowed.
3405
- # * It must start with upper case character and is recommended to use Upper
3406
- # Camel Case style.
3407
- # * The maximum number of characters allowed for the relative_resource_name
3408
- # is 100.
3409
- # Note there are legacy service monitored resources not following this rule.
2824
+ # Required. The monitored resource type. For example, the type `
2825
+ # cloudsql_database` represents databases in Google Cloud SQL. All service
2826
+ # defined monitored resource types must be prefixed with the service name, in
2827
+ # the format of ``service name`/`relative resource name``. The relative resource
2828
+ # name must follow: * Only upper and lower-case letters and digits are allowed. *
2829
+ # It must start with upper case character and is recommended to use Upper Camel
2830
+ # Case style. * The maximum number of characters allowed for the
2831
+ # relative_resource_name is 100. Note there are legacy service monitored
2832
+ # resources not following this rule.
3410
2833
  # Corresponds to the JSON property `type`
3411
2834
  # @return [String]
3412
2835
  attr_accessor :type
@@ -3426,75 +2849,47 @@ module Google
3426
2849
  end
3427
2850
  end
3428
2851
 
3429
- # Monitoring configuration of the service.
3430
- # The example below shows how to configure monitored resources and metrics
3431
- # for monitoring. In the example, a monitored resource and two metrics are
3432
- # defined. The `library.googleapis.com/book/returned_count` metric is sent
3433
- # to both producer and consumer projects, whereas the
3434
- # `library.googleapis.com/book/num_overdue` metric is only sent to the
3435
- # consumer project.
3436
- # monitored_resources:
3437
- # - type: library.googleapis.com/Branch
3438
- # display_name: "Library Branch"
3439
- # description: "A branch of a library."
3440
- # launch_stage: GA
3441
- # labels:
3442
- # - key: resource_container
3443
- # description: "The Cloud container (ie. project id) for the Branch."
3444
- # - key: location
3445
- # description: "The location of the library branch."
3446
- # - key: branch_id
3447
- # description: "The id of the branch."
3448
- # metrics:
3449
- # - name: library.googleapis.com/book/returned_count
3450
- # display_name: "Books Returned"
3451
- # description: "The count of books that have been returned."
3452
- # launch_stage: GA
3453
- # metric_kind: DELTA
3454
- # value_type: INT64
3455
- # unit: "1"
3456
- # labels:
3457
- # - key: customer_id
3458
- # description: "The id of the customer."
3459
- # - name: library.googleapis.com/book/num_overdue
3460
- # display_name: "Books Overdue"
3461
- # description: "The current number of overdue books."
3462
- # launch_stage: GA
3463
- # metric_kind: GAUGE
3464
- # value_type: INT64
3465
- # unit: "1"
3466
- # labels:
3467
- # - key: customer_id
3468
- # description: "The id of the customer."
3469
- # monitoring:
3470
- # producer_destinations:
3471
- # - monitored_resource: library.googleapis.com/Branch
3472
- # metrics:
3473
- # - library.googleapis.com/book/returned_count
3474
- # consumer_destinations:
3475
- # - monitored_resource: library.googleapis.com/Branch
3476
- # metrics:
3477
- # - library.googleapis.com/book/returned_count
3478
- # - library.googleapis.com/book/num_overdue
2852
+ # Monitoring configuration of the service. The example below shows how to
2853
+ # configure monitored resources and metrics for monitoring. In the example, a
2854
+ # monitored resource and two metrics are defined. The `library.googleapis.com/
2855
+ # book/returned_count` metric is sent to both producer and consumer projects,
2856
+ # whereas the `library.googleapis.com/book/num_overdue` metric is only sent to
2857
+ # the consumer project. monitored_resources: - type: library.googleapis.com/
2858
+ # Branch display_name: "Library Branch" description: "A branch of a library."
2859
+ # launch_stage: GA labels: - key: resource_container description: "The Cloud
2860
+ # container (ie. project id) for the Branch." - key: location description: "The
2861
+ # location of the library branch." - key: branch_id description: "The id of the
2862
+ # branch." metrics: - name: library.googleapis.com/book/returned_count
2863
+ # display_name: "Books Returned" description: "The count of books that have been
2864
+ # returned." launch_stage: GA metric_kind: DELTA value_type: INT64 unit: "1"
2865
+ # labels: - key: customer_id description: "The id of the customer." - name:
2866
+ # library.googleapis.com/book/num_overdue display_name: "Books Overdue"
2867
+ # description: "The current number of overdue books." launch_stage: GA
2868
+ # metric_kind: GAUGE value_type: INT64 unit: "1" labels: - key: customer_id
2869
+ # description: "The id of the customer." monitoring: producer_destinations: -
2870
+ # monitored_resource: library.googleapis.com/Branch metrics: - library.
2871
+ # googleapis.com/book/returned_count consumer_destinations: - monitored_resource:
2872
+ # library.googleapis.com/Branch metrics: - library.googleapis.com/book/
2873
+ # returned_count - library.googleapis.com/book/num_overdue
3479
2874
  class Monitoring
3480
2875
  include Google::Apis::Core::Hashable
3481
2876
 
3482
- # Monitoring configurations for sending metrics to the consumer project.
3483
- # There can be multiple consumer destinations. A monitored resource type may
3484
- # appear in multiple monitoring destinations if different aggregations are
3485
- # needed for different sets of metrics associated with that monitored
3486
- # resource type. A monitored resource and metric pair may only be used once
3487
- # in the Monitoring configuration.
2877
+ # Monitoring configurations for sending metrics to the consumer project. There
2878
+ # can be multiple consumer destinations. A monitored resource type may appear in
2879
+ # multiple monitoring destinations if different aggregations are needed for
2880
+ # different sets of metrics associated with that monitored resource type. A
2881
+ # monitored resource and metric pair may only be used once in the Monitoring
2882
+ # configuration.
3488
2883
  # Corresponds to the JSON property `consumerDestinations`
3489
2884
  # @return [Array<Google::Apis::ServiceusageV1::MonitoringDestination>]
3490
2885
  attr_accessor :consumer_destinations
3491
2886
 
3492
- # Monitoring configurations for sending metrics to the producer project.
3493
- # There can be multiple producer destinations. A monitored resource type may
3494
- # appear in multiple monitoring destinations if different aggregations are
3495
- # needed for different sets of metrics associated with that monitored
3496
- # resource type. A monitored resource and metric pair may only be used once
3497
- # in the Monitoring configuration.
2887
+ # Monitoring configurations for sending metrics to the producer project. There
2888
+ # can be multiple producer destinations. A monitored resource type may appear in
2889
+ # multiple monitoring destinations if different aggregations are needed for
2890
+ # different sets of metrics associated with that monitored resource type. A
2891
+ # monitored resource and metric pair may only be used once in the Monitoring
2892
+ # configuration.
3498
2893
  # Corresponds to the JSON property `producerDestinations`
3499
2894
  # @return [Array<Google::Apis::ServiceusageV1::MonitoringDestination>]
3500
2895
  attr_accessor :producer_destinations
@@ -3510,19 +2905,19 @@ module Google
3510
2905
  end
3511
2906
  end
3512
2907
 
3513
- # Configuration of a specific monitoring destination (the producer project
3514
- # or the consumer project).
2908
+ # Configuration of a specific monitoring destination (the producer project or
2909
+ # the consumer project).
3515
2910
  class MonitoringDestination
3516
2911
  include Google::Apis::Core::Hashable
3517
2912
 
3518
- # Types of the metrics to report to this monitoring destination.
3519
- # Each type must be defined in Service.metrics section.
2913
+ # Types of the metrics to report to this monitoring destination. Each type must
2914
+ # be defined in Service.metrics section.
3520
2915
  # Corresponds to the JSON property `metrics`
3521
2916
  # @return [Array<String>]
3522
2917
  attr_accessor :metrics
3523
2918
 
3524
- # The monitored resource type. The type must be defined in
3525
- # Service.monitored_resources section.
2919
+ # The monitored resource type. The type must be defined in Service.
2920
+ # monitored_resources section.
3526
2921
  # Corresponds to the JSON property `monitoredResource`
3527
2922
  # @return [String]
3528
2923
  attr_accessor :monitored_resource
@@ -3539,27 +2934,25 @@ module Google
3539
2934
  end
3540
2935
 
3541
2936
  # OAuth scopes are a way to define data and permissions on data. For example,
3542
- # there are scopes defined for "Read-only access to Google Calendar" and
3543
- # "Access to Cloud Platform". Users can consent to a scope for an application,
3544
- # giving it permission to access that data on their behalf.
3545
- # OAuth scope specifications should be fairly coarse grained; a user will need
3546
- # to see and understand the text description of what your scope means.
3547
- # In most cases: use one or at most two OAuth scopes for an entire family of
3548
- # products. If your product has multiple APIs, you should probably be sharing
3549
- # the OAuth scope across all of those APIs.
3550
- # When you need finer grained OAuth consent screens: talk with your product
3551
- # management about how developers will use them in practice.
3552
- # Please note that even though each of the canonical scopes is enough for a
3553
- # request to be accepted and passed to the backend, a request can still fail
3554
- # due to the backend requiring additional scopes or permissions.
2937
+ # there are scopes defined for "Read-only access to Google Calendar" and "Access
2938
+ # to Cloud Platform". Users can consent to a scope for an application, giving it
2939
+ # permission to access that data on their behalf. OAuth scope specifications
2940
+ # should be fairly coarse grained; a user will need to see and understand the
2941
+ # text description of what your scope means. In most cases: use one or at most
2942
+ # two OAuth scopes for an entire family of products. If your product has
2943
+ # multiple APIs, you should probably be sharing the OAuth scope across all of
2944
+ # those APIs. When you need finer grained OAuth consent screens: talk with your
2945
+ # product management about how developers will use them in practice. Please note
2946
+ # that even though each of the canonical scopes is enough for a request to be
2947
+ # accepted and passed to the backend, a request can still fail due to the
2948
+ # backend requiring additional scopes or permissions.
3555
2949
  class OAuthRequirements
3556
2950
  include Google::Apis::Core::Hashable
3557
2951
 
3558
- # The list of publicly documented OAuth scopes that are allowed access. An
3559
- # OAuth token containing any of these scopes will be accepted.
3560
- # Example:
3561
- # canonical_scopes: https://www.googleapis.com/auth/calendar,
3562
- # https://www.googleapis.com/auth/calendar.read
2952
+ # The list of publicly documented OAuth scopes that are allowed access. An OAuth
2953
+ # token containing any of these scopes will be accepted. Example:
2954
+ # canonical_scopes: https://www.googleapis.com/auth/calendar, https://www.
2955
+ # googleapis.com/auth/calendar.read
3563
2956
  # Corresponds to the JSON property `canonicalScopes`
3564
2957
  # @return [String]
3565
2958
  attr_accessor :canonical_scopes
@@ -3579,47 +2972,45 @@ module Google
3579
2972
  class Operation
3580
2973
  include Google::Apis::Core::Hashable
3581
2974
 
3582
- # If the value is `false`, it means the operation is still in progress.
3583
- # If `true`, the operation is completed, and either `error` or `response` is
3584
- # available.
2975
+ # If the value is `false`, it means the operation is still in progress. If `true`
2976
+ # , the operation is completed, and either `error` or `response` is available.
3585
2977
  # Corresponds to the JSON property `done`
3586
2978
  # @return [Boolean]
3587
2979
  attr_accessor :done
3588
2980
  alias_method :done?, :done
3589
2981
 
3590
- # The `Status` type defines a logical error model that is suitable for
3591
- # different programming environments, including REST APIs and RPC APIs. It is
3592
- # used by [gRPC](https://github.com/grpc). Each `Status` message contains
3593
- # three pieces of data: error code, error message, and error details.
3594
- # You can find out more about this error model and how to work with it in the
3595
- # [API Design Guide](https://cloud.google.com/apis/design/errors).
2982
+ # The `Status` type defines a logical error model that is suitable for different
2983
+ # programming environments, including REST APIs and RPC APIs. It is used by [
2984
+ # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
2985
+ # data: error code, error message, and error details. You can find out more
2986
+ # about this error model and how to work with it in the [API Design Guide](https:
2987
+ # //cloud.google.com/apis/design/errors).
3596
2988
  # Corresponds to the JSON property `error`
3597
2989
  # @return [Google::Apis::ServiceusageV1::Status]
3598
2990
  attr_accessor :error
3599
2991
 
3600
- # Service-specific metadata associated with the operation. It typically
3601
- # contains progress information and common metadata such as create time.
3602
- # Some services might not provide such metadata. Any method that returns a
3603
- # long-running operation should document the metadata type, if any.
2992
+ # Service-specific metadata associated with the operation. It typically contains
2993
+ # progress information and common metadata such as create time. Some services
2994
+ # might not provide such metadata. Any method that returns a long-running
2995
+ # operation should document the metadata type, if any.
3604
2996
  # Corresponds to the JSON property `metadata`
3605
2997
  # @return [Hash<String,Object>]
3606
2998
  attr_accessor :metadata
3607
2999
 
3608
3000
  # The server-assigned name, which is only unique within the same service that
3609
- # originally returns it. If you use the default HTTP mapping, the
3610
- # `name` should be a resource name ending with `operations/`unique_id``.
3001
+ # originally returns it. If you use the default HTTP mapping, the `name` should
3002
+ # be a resource name ending with `operations/`unique_id``.
3611
3003
  # Corresponds to the JSON property `name`
3612
3004
  # @return [String]
3613
3005
  attr_accessor :name
3614
3006
 
3615
- # The normal response of the operation in case of success. If the original
3616
- # method returns no data on success, such as `Delete`, the response is
3617
- # `google.protobuf.Empty`. If the original method is standard
3618
- # `Get`/`Create`/`Update`, the response should be the resource. For other
3619
- # methods, the response should have the type `XxxResponse`, where `Xxx`
3620
- # is the original method name. For example, if the original method name
3621
- # is `TakeSnapshot()`, the inferred response type is
3622
- # `TakeSnapshotResponse`.
3007
+ # The normal response of the operation in case of success. If the original
3008
+ # method returns no data on success, such as `Delete`, the response is `google.
3009
+ # protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`,
3010
+ # the response should be the resource. For other methods, the response should
3011
+ # have the type `XxxResponse`, where `Xxx` is the original method name. For
3012
+ # example, if the original method name is `TakeSnapshot()`, the inferred
3013
+ # response type is `TakeSnapshotResponse`.
3623
3014
  # Corresponds to the JSON property `response`
3624
3015
  # @return [Hash<String,Object>]
3625
3016
  attr_accessor :response
@@ -3642,8 +3033,7 @@ module Google
3642
3033
  class OperationMetadata
3643
3034
  include Google::Apis::Core::Hashable
3644
3035
 
3645
- # The full name of the resources that this operation is directly
3646
- # associated with.
3036
+ # The full name of the resources that this operation is directly associated with.
3647
3037
  # Corresponds to the JSON property `resourceNames`
3648
3038
  # @return [Array<String>]
3649
3039
  attr_accessor :resource_names
@@ -3664,17 +3054,17 @@ module Google
3664
3054
  include Google::Apis::Core::Hashable
3665
3055
 
3666
3056
  # The option's name. For protobuf built-in options (options defined in
3667
- # descriptor.proto), this is the short name. For example, `"map_entry"`.
3668
- # For custom options, it should be the fully-qualified name. For example,
3669
- # `"google.api.http"`.
3057
+ # descriptor.proto), this is the short name. For example, `"map_entry"`. For
3058
+ # custom options, it should be the fully-qualified name. For example, `"google.
3059
+ # api.http"`.
3670
3060
  # Corresponds to the JSON property `name`
3671
3061
  # @return [String]
3672
3062
  attr_accessor :name
3673
3063
 
3674
- # The option's value packed in an Any message. If the value is a primitive,
3675
- # the corresponding wrapper type defined in google/protobuf/wrappers.proto
3676
- # should be used. If the value is an enum, it should be stored as an int32
3677
- # value using the google.protobuf.Int32Value type.
3064
+ # The option's value packed in an Any message. If the value is a primitive, the
3065
+ # corresponding wrapper type defined in google/protobuf/wrappers.proto should be
3066
+ # used. If the value is an enum, it should be stored as an int32 value using the
3067
+ # google.protobuf.Int32Value type.
3678
3068
  # Corresponds to the JSON property `value`
3679
3069
  # @return [Hash<String,Object>]
3680
3070
  attr_accessor :value
@@ -3695,32 +3085,25 @@ module Google
3695
3085
  class Page
3696
3086
  include Google::Apis::Core::Hashable
3697
3087
 
3698
- # The Markdown content of the page. You can use <code>&#40;== include `path`
3699
- # ==&#41;</code> to include content from a Markdown file.
3088
+ # The Markdown content of the page. You can use (== include `path` ==) to
3089
+ # include content from a Markdown file.
3700
3090
  # Corresponds to the JSON property `content`
3701
3091
  # @return [String]
3702
3092
  attr_accessor :content
3703
3093
 
3704
- # The name of the page. It will be used as an identity of the page to
3705
- # generate URI of the page, text of the link to this page in navigation,
3706
- # etc. The full page name (start from the root page name to this page
3707
- # concatenated with `.`) can be used as reference to the page in your
3708
- # documentation. For example:
3709
- # <pre><code>pages:
3710
- # - name: Tutorial
3711
- # content: &#40;== include tutorial.md ==&#41;
3712
- # subpages:
3713
- # - name: Java
3714
- # content: &#40;== include tutorial_java.md ==&#41;
3715
- # </code></pre>
3716
- # You can reference `Java` page using Markdown reference link syntax:
3717
- # `Java`.
3094
+ # The name of the page. It will be used as an identity of the page to generate
3095
+ # URI of the page, text of the link to this page in navigation, etc. The full
3096
+ # page name (start from the root page name to this page concatenated with `.`)
3097
+ # can be used as reference to the page in your documentation. For example: pages:
3098
+ # - name: Tutorial content: (== include tutorial.md ==) subpages: - name: Java
3099
+ # content: (== include tutorial_java.md ==) You can reference `Java` page using
3100
+ # Markdown reference link syntax: `Java`.
3718
3101
  # Corresponds to the JSON property `name`
3719
3102
  # @return [String]
3720
3103
  attr_accessor :name
3721
3104
 
3722
- # Subpages of this page. The order of subpages specified here will be
3723
- # honored in the generated docset.
3105
+ # Subpages of this page. The order of subpages specified here will be honored in
3106
+ # the generated docset.
3724
3107
  # Corresponds to the JSON property `subpages`
3725
3108
  # @return [Array<Google::Apis::ServiceusageV1::Page>]
3726
3109
  attr_accessor :subpages
@@ -3737,46 +3120,25 @@ module Google
3737
3120
  end
3738
3121
  end
3739
3122
 
3740
- # Quota configuration helps to achieve fairness and budgeting in service
3741
- # usage.
3742
- # The metric based quota configuration works this way:
3743
- # - The service configuration defines a set of metrics.
3744
- # - For API calls, the quota.metric_rules maps methods to metrics with
3745
- # corresponding costs.
3746
- # - The quota.limits defines limits on the metrics, which will be used for
3747
- # quota checks at runtime.
3748
- # An example quota configuration in yaml format:
3749
- # quota:
3750
- # limits:
3751
- # - name: apiWriteQpsPerProject
3752
- # metric: library.googleapis.com/write_calls
3753
- # unit: "1/min/`project`" # rate limit for consumer projects
3754
- # values:
3755
- # STANDARD: 10000
3756
- # # The metric rules bind all methods to the read_calls metric,
3757
- # # except for the UpdateBook and DeleteBook methods. These two methods
3758
- # # are mapped to the write_calls metric, with the UpdateBook method
3759
- # # consuming at twice rate as the DeleteBook method.
3760
- # metric_rules:
3761
- # - selector: "*"
3762
- # metric_costs:
3763
- # library.googleapis.com/read_calls: 1
3764
- # - selector: google.example.library.v1.LibraryService.UpdateBook
3765
- # metric_costs:
3766
- # library.googleapis.com/write_calls: 2
3767
- # - selector: google.example.library.v1.LibraryService.DeleteBook
3768
- # metric_costs:
3769
- # library.googleapis.com/write_calls: 1
3770
- # Corresponding Metric definition:
3771
- # metrics:
3772
- # - name: library.googleapis.com/read_calls
3773
- # display_name: Read requests
3774
- # metric_kind: DELTA
3775
- # value_type: INT64
3776
- # - name: library.googleapis.com/write_calls
3777
- # display_name: Write requests
3778
- # metric_kind: DELTA
3779
- # value_type: INT64
3123
+ # Quota configuration helps to achieve fairness and budgeting in service usage.
3124
+ # The metric based quota configuration works this way: - The service
3125
+ # configuration defines a set of metrics. - For API calls, the quota.
3126
+ # metric_rules maps methods to metrics with corresponding costs. - The quota.
3127
+ # limits defines limits on the metrics, which will be used for quota checks at
3128
+ # runtime. An example quota configuration in yaml format: quota: limits: - name:
3129
+ # apiWriteQpsPerProject metric: library.googleapis.com/write_calls unit: "1/min/`
3130
+ # project`" # rate limit for consumer projects values: STANDARD: 10000 # The
3131
+ # metric rules bind all methods to the read_calls metric, # except for the
3132
+ # UpdateBook and DeleteBook methods. These two methods # are mapped to the
3133
+ # write_calls metric, with the UpdateBook method # consuming at twice rate as
3134
+ # the DeleteBook method. metric_rules: - selector: "*" metric_costs: library.
3135
+ # googleapis.com/read_calls: 1 - selector: google.example.library.v1.
3136
+ # LibraryService.UpdateBook metric_costs: library.googleapis.com/write_calls: 2 -
3137
+ # selector: google.example.library.v1.LibraryService.DeleteBook metric_costs:
3138
+ # library.googleapis.com/write_calls: 1 Corresponding Metric definition: metrics:
3139
+ # - name: library.googleapis.com/read_calls display_name: Read requests
3140
+ # metric_kind: DELTA value_type: INT64 - name: library.googleapis.com/
3141
+ # write_calls display_name: Write requests metric_kind: DELTA value_type: INT64
3780
3142
  class Quota
3781
3143
  include Google::Apis::Core::Hashable
3782
3144
 
@@ -3785,8 +3147,8 @@ module Google
3785
3147
  # @return [Array<Google::Apis::ServiceusageV1::QuotaLimit>]
3786
3148
  attr_accessor :limits
3787
3149
 
3788
- # List of `MetricRule` definitions, each one mapping a selected method to one
3789
- # or more metrics.
3150
+ # List of `MetricRule` definitions, each one mapping a selected method to one or
3151
+ # more metrics.
3790
3152
  # Corresponds to the JSON property `metricRules`
3791
3153
  # @return [Array<Google::Apis::ServiceusageV1::MetricRule>]
3792
3154
  attr_accessor :metric_rules
@@ -3803,95 +3165,89 @@ module Google
3803
3165
  end
3804
3166
 
3805
3167
  # `QuotaLimit` defines a specific limit that applies over a specified duration
3806
- # for a limit type. There can be at most one limit for a duration and limit
3807
- # type combination defined within a `QuotaGroup`.
3168
+ # for a limit type. There can be at most one limit for a duration and limit type
3169
+ # combination defined within a `QuotaGroup`.
3808
3170
  class QuotaLimit
3809
3171
  include Google::Apis::Core::Hashable
3810
3172
 
3811
- # Default number of tokens that can be consumed during the specified
3812
- # duration. This is the number of tokens assigned when a client
3813
- # application developer activates the service for his/her project.
3814
- # Specifying a value of 0 will block all requests. This can be used if you
3815
- # are provisioning quota to selected consumers and blocking others.
3816
- # Similarly, a value of -1 will indicate an unlimited quota. No other
3817
- # negative values are allowed.
3818
- # Used by group-based quotas only.
3173
+ # Default number of tokens that can be consumed during the specified duration.
3174
+ # This is the number of tokens assigned when a client application developer
3175
+ # activates the service for his/her project. Specifying a value of 0 will block
3176
+ # all requests. This can be used if you are provisioning quota to selected
3177
+ # consumers and blocking others. Similarly, a value of -1 will indicate an
3178
+ # unlimited quota. No other negative values are allowed. Used by group-based
3179
+ # quotas only.
3819
3180
  # Corresponds to the JSON property `defaultLimit`
3820
3181
  # @return [Fixnum]
3821
3182
  attr_accessor :default_limit
3822
3183
 
3823
- # Optional. User-visible, extended description for this quota limit.
3824
- # Should be used only when more context is needed to understand this limit
3825
- # than provided by the limit's display name (see: `display_name`).
3184
+ # Optional. User-visible, extended description for this quota limit. Should be
3185
+ # used only when more context is needed to understand this limit than provided
3186
+ # by the limit's display name (see: `display_name`).
3826
3187
  # Corresponds to the JSON property `description`
3827
3188
  # @return [String]
3828
3189
  attr_accessor :description
3829
3190
 
3830
- # User-visible display name for this limit.
3831
- # Optional. If not set, the UI will provide a default display name based on
3832
- # the quota configuration. This field can be used to override the default
3833
- # display name generated from the configuration.
3191
+ # User-visible display name for this limit. Optional. If not set, the UI will
3192
+ # provide a default display name based on the quota configuration. This field
3193
+ # can be used to override the default display name generated from the
3194
+ # configuration.
3834
3195
  # Corresponds to the JSON property `displayName`
3835
3196
  # @return [String]
3836
3197
  attr_accessor :display_name
3837
3198
 
3838
- # Duration of this limit in textual notation. Must be "100s" or "1d".
3839
- # Used by group-based quotas only.
3199
+ # Duration of this limit in textual notation. Must be "100s" or "1d". Used by
3200
+ # group-based quotas only.
3840
3201
  # Corresponds to the JSON property `duration`
3841
3202
  # @return [String]
3842
3203
  attr_accessor :duration
3843
3204
 
3844
- # Free tier value displayed in the Developers Console for this limit.
3845
- # The free tier is the number of tokens that will be subtracted from the
3846
- # billed amount when billing is enabled.
3847
- # This field can only be set on a limit with duration "1d", in a billable
3848
- # group; it is invalid on any other limit. If this field is not set, it
3849
- # defaults to 0, indicating that there is no free tier for this service.
3850
- # Used by group-based quotas only.
3205
+ # Free tier value displayed in the Developers Console for this limit. The free
3206
+ # tier is the number of tokens that will be subtracted from the billed amount
3207
+ # when billing is enabled. This field can only be set on a limit with duration "
3208
+ # 1d", in a billable group; it is invalid on any other limit. If this field is
3209
+ # not set, it defaults to 0, indicating that there is no free tier for this
3210
+ # service. Used by group-based quotas only.
3851
3211
  # Corresponds to the JSON property `freeTier`
3852
3212
  # @return [Fixnum]
3853
3213
  attr_accessor :free_tier
3854
3214
 
3855
- # Maximum number of tokens that can be consumed during the specified
3856
- # duration. Client application developers can override the default limit up
3857
- # to this maximum. If specified, this value cannot be set to a value less
3858
- # than the default limit. If not specified, it is set to the default limit.
3859
- # To allow clients to apply overrides with no upper bound, set this to -1,
3860
- # indicating unlimited maximum quota.
3861
- # Used by group-based quotas only.
3215
+ # Maximum number of tokens that can be consumed during the specified duration.
3216
+ # Client application developers can override the default limit up to this
3217
+ # maximum. If specified, this value cannot be set to a value less than the
3218
+ # default limit. If not specified, it is set to the default limit. To allow
3219
+ # clients to apply overrides with no upper bound, set this to -1, indicating
3220
+ # unlimited maximum quota. Used by group-based quotas only.
3862
3221
  # Corresponds to the JSON property `maxLimit`
3863
3222
  # @return [Fixnum]
3864
3223
  attr_accessor :max_limit
3865
3224
 
3866
- # The name of the metric this quota limit applies to. The quota limits with
3867
- # the same metric will be checked together during runtime. The metric must be
3225
+ # The name of the metric this quota limit applies to. The quota limits with the
3226
+ # same metric will be checked together during runtime. The metric must be
3868
3227
  # defined within the service config.
3869
3228
  # Corresponds to the JSON property `metric`
3870
3229
  # @return [String]
3871
3230
  attr_accessor :metric
3872
3231
 
3873
- # Name of the quota limit.
3874
- # The name must be provided, and it must be unique within the service. The
3875
- # name can only include alphanumeric characters as well as '-'.
3876
- # The maximum length of the limit name is 64 characters.
3232
+ # Name of the quota limit. The name must be provided, and it must be unique
3233
+ # within the service. The name can only include alphanumeric characters as well
3234
+ # as '-'. The maximum length of the limit name is 64 characters.
3877
3235
  # Corresponds to the JSON property `name`
3878
3236
  # @return [String]
3879
3237
  attr_accessor :name
3880
3238
 
3881
- # Specify the unit of the quota limit. It uses the same syntax as
3882
- # Metric.unit. The supported unit kinds are determined by the quota
3883
- # backend system.
3884
- # Here are some examples:
3885
- # * "1/min/`project`" for quota per minute per project.
3886
- # Note: the order of unit components is insignificant.
3887
- # The "1" at the beginning is required to follow the metric unit syntax.
3239
+ # Specify the unit of the quota limit. It uses the same syntax as Metric.unit.
3240
+ # The supported unit kinds are determined by the quota backend system. Here are
3241
+ # some examples: * "1/min/`project`" for quota per minute per project. Note: the
3242
+ # order of unit components is insignificant. The "1" at the beginning is
3243
+ # required to follow the metric unit syntax.
3888
3244
  # Corresponds to the JSON property `unit`
3889
3245
  # @return [String]
3890
3246
  attr_accessor :unit
3891
3247
 
3892
3248
  # Tiered limit values. You must specify this as a key:value pair, with an
3893
- # integer value that is the maximum number of requests allowed for the
3894
- # specified unit. Currently only STANDARD is supported.
3249
+ # integer value that is the maximum number of requests allowed for the specified
3250
+ # unit. Currently only STANDARD is supported.
3895
3251
  # Corresponds to the JSON property `values`
3896
3252
  # @return [Hash<String,Fixnum>]
3897
3253
  attr_accessor :values
@@ -3919,66 +3275,58 @@ module Google
3919
3275
  class QuotaOverride
3920
3276
  include Google::Apis::Core::Hashable
3921
3277
 
3922
- # The resource name of the ancestor that requested the override. For example:
3923
- # "organizations/12345" or "folders/67890".
3924
- # Used by admin overrides only.
3278
+ # The resource name of the ancestor that requested the override. For example: "
3279
+ # organizations/12345" or "folders/67890". Used by admin overrides only.
3925
3280
  # Corresponds to the JSON property `adminOverrideAncestor`
3926
3281
  # @return [String]
3927
3282
  attr_accessor :admin_override_ancestor
3928
3283
 
3929
3284
  # If this map is nonempty, then this override applies only to specific values
3930
- # for dimensions defined in the limit unit.
3931
- # For example, an override on a limit with the unit 1/`project`/`region`
3932
- # could contain an entry with the key "region" and the value "us-east-1";
3933
- # the override is only applied to quota consumed in that region.
3934
- # This map has the following restrictions:
3935
- # * Keys that are not defined in the limit's unit are not valid keys.
3936
- # Any string appearing in `brackets` in the unit (besides `project` or
3937
- # `user`) is a defined key.
3938
- # * "project" is not a valid key; the project is already specified in
3939
- # the parent resource name.
3940
- # * "user" is not a valid key; the API does not support quota overrides
3941
- # that apply only to a specific user.
3942
- # * If "region" appears as a key, its value must be a valid Cloud region.
3943
- # * If "zone" appears as a key, its value must be a valid Cloud zone.
3944
- # * If any valid key other than "region" or "zone" appears in the map, then
3945
- # all valid keys other than "region" or "zone" must also appear in the
3946
- # map.
3285
+ # for dimensions defined in the limit unit. For example, an override on a limit
3286
+ # with the unit 1/`project`/`region` could contain an entry with the key "region"
3287
+ # and the value "us-east-1"; the override is only applied to quota consumed in
3288
+ # that region. This map has the following restrictions: * Keys that are not
3289
+ # defined in the limit's unit are not valid keys. Any string appearing in `
3290
+ # brackets` in the unit (besides `project` or `user`) is a defined key. * "
3291
+ # project" is not a valid key; the project is already specified in the parent
3292
+ # resource name. * "user" is not a valid key; the API does not support quota
3293
+ # overrides that apply only to a specific user. * If "region" appears as a key,
3294
+ # its value must be a valid Cloud region. * If "zone" appears as a key, its
3295
+ # value must be a valid Cloud zone. * If any valid key other than "region" or "
3296
+ # zone" appears in the map, then all valid keys other than "region" or "zone"
3297
+ # must also appear in the map.
3947
3298
  # Corresponds to the JSON property `dimensions`
3948
3299
  # @return [Hash<String,String>]
3949
3300
  attr_accessor :dimensions
3950
3301
 
3951
- # The name of the metric to which this override applies.
3952
- # An example name would be:
3953
- # `compute.googleapis.com/cpus`
3302
+ # The name of the metric to which this override applies. An example name would
3303
+ # be: `compute.googleapis.com/cpus`
3954
3304
  # Corresponds to the JSON property `metric`
3955
3305
  # @return [String]
3956
3306
  attr_accessor :metric
3957
3307
 
3958
- # The resource name of the override.
3959
- # This name is generated by the server when the override is created.
3960
- # Example names would be:
3961
- # `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.
3962
- # googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/adminOverrides/4a3f2c1d`
3963
- # `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.
3964
- # googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/consumerOverrides/4a3f2c1d`
3965
- # The resource name is intended to be opaque and should not be parsed for
3966
- # its component strings, since its representation could change in the future.
3308
+ # The resource name of the override. This name is generated by the server when
3309
+ # the override is created. Example names would be: `projects/123/services/
3310
+ # compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/
3311
+ # limits/%2Fproject%2Fregion/adminOverrides/4a3f2c1d` `projects/123/services/
3312
+ # compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/
3313
+ # limits/%2Fproject%2Fregion/consumerOverrides/4a3f2c1d` The resource name is
3314
+ # intended to be opaque and should not be parsed for its component strings,
3315
+ # since its representation could change in the future.
3967
3316
  # Corresponds to the JSON property `name`
3968
3317
  # @return [String]
3969
3318
  attr_accessor :name
3970
3319
 
3971
- # The overriding quota limit value.
3972
- # Can be any nonnegative integer, or -1 (unlimited quota).
3320
+ # The overriding quota limit value. Can be any nonnegative integer, or -1 (
3321
+ # unlimited quota).
3973
3322
  # Corresponds to the JSON property `overrideValue`
3974
3323
  # @return [Fixnum]
3975
3324
  attr_accessor :override_value
3976
3325
 
3977
- # The limit unit of the limit to which this override applies.
3978
- # An example unit would be:
3979
- # `1/`project`/`region``
3980
- # Note that ``project`` and ``region`` are not placeholders in this example;
3981
- # the literal characters ``` and ``` occur in the string.
3326
+ # The limit unit of the limit to which this override applies. An example unit
3327
+ # would be: `1/`project`/`region`` Note that ``project`` and ``region`` are not
3328
+ # placeholders in this example; the literal characters ``` and ``` occur in the
3329
+ # string.
3982
3330
  # Corresponds to the JSON property `unit`
3983
3331
  # @return [String]
3984
3332
  attr_accessor :unit
@@ -4003,15 +3351,14 @@ module Google
4003
3351
  class ServiceIdentity
4004
3352
  include Google::Apis::Core::Hashable
4005
3353
 
4006
- # The email address of the service account that a service producer would use
4007
- # to access consumer resources.
3354
+ # The email address of the service account that a service producer would use to
3355
+ # access consumer resources.
4008
3356
  # Corresponds to the JSON property `email`
4009
3357
  # @return [String]
4010
3358
  attr_accessor :email
4011
3359
 
4012
- # The unique and stable id of the service account.
4013
- # https://cloud.google.com/iam/reference/rest/v1/projects.serviceAccounts#
4014
- # ServiceAccount
3360
+ # The unique and stable id of the service account. https://cloud.google.com/iam/
3361
+ # reference/rest/v1/projects.serviceAccounts#ServiceAccount
4015
3362
  # Corresponds to the JSON property `uniqueId`
4016
3363
  # @return [String]
4017
3364
  attr_accessor :unique_id
@@ -4027,13 +3374,13 @@ module Google
4027
3374
  end
4028
3375
  end
4029
3376
 
4030
- # `SourceContext` represents information about the source of a
4031
- # protobuf element, like the file in which it is defined.
3377
+ # `SourceContext` represents information about the source of a protobuf element,
3378
+ # like the file in which it is defined.
4032
3379
  class SourceContext
4033
3380
  include Google::Apis::Core::Hashable
4034
3381
 
4035
3382
  # The path-qualified name of the .proto file that contained the associated
4036
- # protobuf element. For example: `"google/protobuf/source_context.proto"`.
3383
+ # protobuf element. For example: `"google/protobuf/source_context.proto"`.
4037
3384
  # Corresponds to the JSON property `fileName`
4038
3385
  # @return [String]
4039
3386
  attr_accessor :file_name
@@ -4067,12 +3414,12 @@ module Google
4067
3414
  end
4068
3415
  end
4069
3416
 
4070
- # The `Status` type defines a logical error model that is suitable for
4071
- # different programming environments, including REST APIs and RPC APIs. It is
4072
- # used by [gRPC](https://github.com/grpc). Each `Status` message contains
4073
- # three pieces of data: error code, error message, and error details.
4074
- # You can find out more about this error model and how to work with it in the
4075
- # [API Design Guide](https://cloud.google.com/apis/design/errors).
3417
+ # The `Status` type defines a logical error model that is suitable for different
3418
+ # programming environments, including REST APIs and RPC APIs. It is used by [
3419
+ # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
3420
+ # data: error code, error message, and error details. You can find out more
3421
+ # about this error model and how to work with it in the [API Design Guide](https:
3422
+ # //cloud.google.com/apis/design/errors).
4076
3423
  class Status
4077
3424
  include Google::Apis::Core::Hashable
4078
3425
 
@@ -4081,15 +3428,15 @@ module Google
4081
3428
  # @return [Fixnum]
4082
3429
  attr_accessor :code
4083
3430
 
4084
- # A list of messages that carry the error details. There is a common set of
3431
+ # A list of messages that carry the error details. There is a common set of
4085
3432
  # message types for APIs to use.
4086
3433
  # Corresponds to the JSON property `details`
4087
3434
  # @return [Array<Hash<String,Object>>]
4088
3435
  attr_accessor :details
4089
3436
 
4090
- # A developer-facing error message, which should be in English. Any
4091
- # user-facing error message should be localized and sent in the
4092
- # google.rpc.Status.details field, or localized by the client.
3437
+ # A developer-facing error message, which should be in English. Any user-facing
3438
+ # error message should be localized and sent in the google.rpc.Status.details
3439
+ # field, or localized by the client.
4093
3440
  # Corresponds to the JSON property `message`
4094
3441
  # @return [String]
4095
3442
  attr_accessor :message
@@ -4112,8 +3459,7 @@ module Google
4112
3459
  class SystemParameter
4113
3460
  include Google::Apis::Core::Hashable
4114
3461
 
4115
- # Define the HTTP header name to use for the parameter. It is case
4116
- # insensitive.
3462
+ # Define the HTTP header name to use for the parameter. It is case insensitive.
4117
3463
  # Corresponds to the JSON property `httpHeader`
4118
3464
  # @return [String]
4119
3465
  attr_accessor :http_header
@@ -4141,23 +3487,20 @@ module Google
4141
3487
  end
4142
3488
  end
4143
3489
 
4144
- # Define a system parameter rule mapping system parameter definitions to
4145
- # methods.
3490
+ # Define a system parameter rule mapping system parameter definitions to methods.
4146
3491
  class SystemParameterRule
4147
3492
  include Google::Apis::Core::Hashable
4148
3493
 
4149
- # Define parameters. Multiple names may be defined for a parameter.
4150
- # For a given method call, only one of them should be used. If multiple
4151
- # names are used the behavior is implementation-dependent.
4152
- # If none of the specified names are present the behavior is
4153
- # parameter-dependent.
3494
+ # Define parameters. Multiple names may be defined for a parameter. For a given
3495
+ # method call, only one of them should be used. If multiple names are used the
3496
+ # behavior is implementation-dependent. If none of the specified names are
3497
+ # present the behavior is parameter-dependent.
4154
3498
  # Corresponds to the JSON property `parameters`
4155
3499
  # @return [Array<Google::Apis::ServiceusageV1::SystemParameter>]
4156
3500
  attr_accessor :parameters
4157
3501
 
4158
3502
  # Selects the methods to which this rule applies. Use '*' to indicate all
4159
- # methods in all APIs.
4160
- # Refer to selector for syntax details.
3503
+ # methods in all APIs. Refer to selector for syntax details.
4161
3504
  # Corresponds to the JSON property `selector`
4162
3505
  # @return [String]
4163
3506
  attr_accessor :selector
@@ -4173,36 +3516,23 @@ module Google
4173
3516
  end
4174
3517
  end
4175
3518
 
4176
- # ### System parameter configuration
4177
- # A system parameter is a special kind of parameter defined by the API
4178
- # system, not by an individual API. It is typically mapped to an HTTP header
4179
- # and/or a URL query parameter. This configuration specifies which methods
4180
- # change the names of the system parameters.
3519
+ # ### System parameter configuration A system parameter is a special kind of
3520
+ # parameter defined by the API system, not by an individual API. It is typically
3521
+ # mapped to an HTTP header and/or a URL query parameter. This configuration
3522
+ # specifies which methods change the names of the system parameters.
4181
3523
  class SystemParameters
4182
3524
  include Google::Apis::Core::Hashable
4183
3525
 
4184
- # Define system parameters.
4185
- # The parameters defined here will override the default parameters
4186
- # implemented by the system. If this field is missing from the service
4187
- # config, default system parameters will be used. Default system parameters
4188
- # and names is implementation-dependent.
4189
- # Example: define api key for all methods
4190
- # system_parameters
4191
- # rules:
4192
- # - selector: "*"
4193
- # parameters:
4194
- # - name: api_key
4195
- # url_query_parameter: api_key
4196
- # Example: define 2 api key names for a specific method.
4197
- # system_parameters
4198
- # rules:
4199
- # - selector: "/ListShelves"
4200
- # parameters:
4201
- # - name: api_key
4202
- # http_header: Api-Key1
4203
- # - name: api_key
4204
- # http_header: Api-Key2
4205
- # **NOTE:** All service configuration rules follow "last one wins" order.
3526
+ # Define system parameters. The parameters defined here will override the
3527
+ # default parameters implemented by the system. If this field is missing from
3528
+ # the service config, default system parameters will be used. Default system
3529
+ # parameters and names is implementation-dependent. Example: define api key for
3530
+ # all methods system_parameters rules: - selector: "*" parameters: - name:
3531
+ # api_key url_query_parameter: api_key Example: define 2 api key names for a
3532
+ # specific method. system_parameters rules: - selector: "/ListShelves"
3533
+ # parameters: - name: api_key http_header: Api-Key1 - name: api_key http_header:
3534
+ # Api-Key2 **NOTE:** All service configuration rules follow "last one wins"
3535
+ # order.
4206
3536
  # Corresponds to the JSON property `rules`
4207
3537
  # @return [Array<Google::Apis::ServiceusageV1::SystemParameterRule>]
4208
3538
  attr_accessor :rules
@@ -4241,8 +3571,8 @@ module Google
4241
3571
  # @return [Array<Google::Apis::ServiceusageV1::Option>]
4242
3572
  attr_accessor :options
4243
3573
 
4244
- # `SourceContext` represents information about the source of a
4245
- # protobuf element, like the file in which it is defined.
3574
+ # `SourceContext` represents information about the source of a protobuf element,
3575
+ # like the file in which it is defined.
4246
3576
  # Corresponds to the JSON property `sourceContext`
4247
3577
  # @return [Google::Apis::ServiceusageV1::SourceContext]
4248
3578
  attr_accessor :source_context
@@ -4272,37 +3602,33 @@ module Google
4272
3602
  include Google::Apis::Core::Hashable
4273
3603
 
4274
3604
  # The full resource name of a channel used for sending notifications to the
4275
- # service producer.
4276
- # Google Service Management currently only supports
4277
- # [Google Cloud Pub/Sub](https://cloud.google.com/pubsub) as a notification
4278
- # channel. To use Google Cloud Pub/Sub as the channel, this must be the name
4279
- # of a Cloud Pub/Sub topic that uses the Cloud Pub/Sub topic name format
4280
- # documented in https://cloud.google.com/pubsub/docs/overview.
3605
+ # service producer. Google Service Management currently only supports [Google
3606
+ # Cloud Pub/Sub](https://cloud.google.com/pubsub) as a notification channel. To
3607
+ # use Google Cloud Pub/Sub as the channel, this must be the name of a Cloud Pub/
3608
+ # Sub topic that uses the Cloud Pub/Sub topic name format documented in https://
3609
+ # cloud.google.com/pubsub/docs/overview.
4281
3610
  # Corresponds to the JSON property `producerNotificationChannel`
4282
3611
  # @return [String]
4283
3612
  attr_accessor :producer_notification_channel
4284
3613
 
4285
3614
  # Requirements that must be satisfied before a consumer project can use the
4286
- # service. Each requirement is of the form <service.name>/<requirement-id>;
4287
- # for example 'serviceusage.googleapis.com/billing-enabled'.
3615
+ # service. Each requirement is of the form /; for example 'serviceusage.
3616
+ # googleapis.com/billing-enabled'.
4288
3617
  # Corresponds to the JSON property `requirements`
4289
3618
  # @return [Array<String>]
4290
3619
  attr_accessor :requirements
4291
3620
 
4292
- # A list of usage rules that apply to individual API methods.
4293
- # **NOTE:** All service configuration rules follow "last one wins" order.
3621
+ # A list of usage rules that apply to individual API methods. **NOTE:** All
3622
+ # service configuration rules follow "last one wins" order.
4294
3623
  # Corresponds to the JSON property `rules`
4295
3624
  # @return [Array<Google::Apis::ServiceusageV1::UsageRule>]
4296
3625
  attr_accessor :rules
4297
3626
 
4298
- # The per-product per-project service identity for a service.
4299
- # Use this field to configure per-product per-project service identity.
4300
- # Example of a service identity configuration.
4301
- # usage:
4302
- # service_identity:
4303
- # - service_account_parent: "projects/123456789"
4304
- # display_name: "Cloud XXX Service Agent"
4305
- # description: "Used as the identity of Cloud XXX to access resources"
3627
+ # The per-product per-project service identity for a service. Use this field to
3628
+ # configure per-product per-project service identity. Example of a service
3629
+ # identity configuration. usage: service_identity: - service_account_parent: "
3630
+ # projects/123456789" display_name: "Cloud XXX Service Agent" description: "Used
3631
+ # as the identity of Cloud XXX to access resources"
4306
3632
  # Corresponds to the JSON property `serviceIdentity`
4307
3633
  # @return [Google::Apis::ServiceusageV1::GoogleApiServiceIdentity]
4308
3634
  attr_accessor :service_identity
@@ -4320,45 +3646,36 @@ module Google
4320
3646
  end
4321
3647
  end
4322
3648
 
4323
- # Usage configuration rules for the service.
4324
- # NOTE: Under development.
4325
- # Use this rule to configure unregistered calls for the service. Unregistered
4326
- # calls are calls that do not contain consumer project identity.
4327
- # (Example: calls that do not contain an API key).
4328
- # By default, API methods do not allow unregistered calls, and each method call
4329
- # must be identified by a consumer project identity. Use this rule to
4330
- # allow/disallow unregistered calls.
4331
- # Example of an API that wants to allow unregistered calls for entire service.
4332
- # usage:
4333
- # rules:
4334
- # - selector: "*"
4335
- # allow_unregistered_calls: true
4336
- # Example of a method that wants to allow unregistered calls.
4337
- # usage:
4338
- # rules:
4339
- # - selector: "google.example.library.v1.LibraryService.CreateBook"
4340
- # allow_unregistered_calls: true
3649
+ # Usage configuration rules for the service. NOTE: Under development. Use this
3650
+ # rule to configure unregistered calls for the service. Unregistered calls are
3651
+ # calls that do not contain consumer project identity. (Example: calls that do
3652
+ # not contain an API key). By default, API methods do not allow unregistered
3653
+ # calls, and each method call must be identified by a consumer project identity.
3654
+ # Use this rule to allow/disallow unregistered calls. Example of an API that
3655
+ # wants to allow unregistered calls for entire service. usage: rules: - selector:
3656
+ # "*" allow_unregistered_calls: true Example of a method that wants to allow
3657
+ # unregistered calls. usage: rules: - selector: "google.example.library.v1.
3658
+ # LibraryService.CreateBook" allow_unregistered_calls: true
4341
3659
  class UsageRule
4342
3660
  include Google::Apis::Core::Hashable
4343
3661
 
4344
- # If true, the selected method allows unregistered calls, e.g. calls
4345
- # that don't identify any user or application.
3662
+ # If true, the selected method allows unregistered calls, e.g. calls that don't
3663
+ # identify any user or application.
4346
3664
  # Corresponds to the JSON property `allowUnregisteredCalls`
4347
3665
  # @return [Boolean]
4348
3666
  attr_accessor :allow_unregistered_calls
4349
3667
  alias_method :allow_unregistered_calls?, :allow_unregistered_calls
4350
3668
 
4351
3669
  # Selects the methods to which this rule applies. Use '*' to indicate all
4352
- # methods in all APIs.
4353
- # Refer to selector for syntax details.
3670
+ # methods in all APIs. Refer to selector for syntax details.
4354
3671
  # Corresponds to the JSON property `selector`
4355
3672
  # @return [String]
4356
3673
  attr_accessor :selector
4357
3674
 
4358
- # If true, the selected method should skip service control and the control
4359
- # plane features, such as quota and billing, will not be available.
4360
- # This flag is used by Google Cloud Endpoints to bypass checks for internal
4361
- # methods, such as service health check methods.
3675
+ # If true, the selected method should skip service control and the control plane
3676
+ # features, such as quota and billing, will not be available. This flag is used
3677
+ # by Google Cloud Endpoints to bypass checks for internal methods, such as
3678
+ # service health check methods.
4362
3679
  # Corresponds to the JSON property `skipServiceControl`
4363
3680
  # @return [Boolean]
4364
3681
  attr_accessor :skip_service_control