google-api-client 0.42.2 → 0.43.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +129 -0
- data/generated/google/apis/abusiveexperiencereport_v1.rb +1 -1
- data/generated/google/apis/abusiveexperiencereport_v1/classes.rb +8 -13
- data/generated/google/apis/abusiveexperiencereport_v1/service.rb +2 -3
- data/generated/google/apis/accessapproval_v1.rb +1 -1
- data/generated/google/apis/accessapproval_v1/classes.rb +9 -0
- data/generated/google/apis/accessapproval_v1/representations.rb +1 -0
- data/generated/google/apis/adexchangebuyer2_v2beta1.rb +1 -1
- data/generated/google/apis/adexchangebuyer2_v2beta1/classes.rb +523 -653
- data/generated/google/apis/adexchangebuyer2_v2beta1/service.rb +467 -631
- data/generated/google/apis/adexperiencereport_v1.rb +1 -1
- data/generated/google/apis/adexperiencereport_v1/classes.rb +11 -18
- data/generated/google/apis/adexperiencereport_v1/service.rb +2 -3
- data/generated/google/apis/admob_v1.rb +1 -1
- data/generated/google/apis/admob_v1/classes.rb +139 -270
- data/generated/google/apis/admob_v1/service.rb +11 -13
- data/generated/google/apis/alertcenter_v1beta1.rb +1 -1
- data/generated/google/apis/alertcenter_v1beta1/classes.rb +107 -138
- data/generated/google/apis/alertcenter_v1beta1/service.rb +50 -55
- data/generated/google/apis/analyticsreporting_v4.rb +1 -1
- data/generated/google/apis/analyticsreporting_v4/classes.rb +315 -399
- data/generated/google/apis/androiddeviceprovisioning_v1.rb +1 -1
- data/generated/google/apis/androiddeviceprovisioning_v1/classes.rb +193 -220
- data/generated/google/apis/androiddeviceprovisioning_v1/service.rb +55 -61
- data/generated/google/apis/androidenterprise_v1.rb +1 -1
- data/generated/google/apis/androidenterprise_v1/classes.rb +452 -557
- data/generated/google/apis/androidenterprise_v1/service.rb +181 -240
- data/generated/google/apis/androidmanagement_v1.rb +1 -1
- data/generated/google/apis/androidpublisher_v3.rb +1 -1
- data/generated/google/apis/androidpublisher_v3/classes.rb +281 -342
- data/generated/google/apis/androidpublisher_v3/service.rb +125 -153
- data/generated/google/apis/apigee_v1.rb +6 -7
- data/generated/google/apis/apigee_v1/classes.rb +733 -1180
- data/generated/google/apis/apigee_v1/service.rb +879 -1133
- data/generated/google/apis/appsmarket_v2.rb +1 -1
- data/generated/google/apis/bigtableadmin_v2.rb +1 -1
- data/generated/google/apis/bigtableadmin_v2/service.rb +1 -1
- data/generated/google/apis/billingbudgets_v1beta1.rb +1 -1
- data/generated/google/apis/billingbudgets_v1beta1/classes.rb +97 -118
- data/generated/google/apis/billingbudgets_v1beta1/service.rb +30 -33
- data/generated/google/apis/blogger_v2.rb +2 -3
- data/generated/google/apis/blogger_v2/classes.rb +1 -2
- data/generated/google/apis/blogger_v2/service.rb +1 -2
- data/generated/google/apis/blogger_v3.rb +2 -3
- data/generated/google/apis/blogger_v3/classes.rb +1 -2
- data/generated/google/apis/blogger_v3/service.rb +1 -2
- data/generated/google/apis/chromeuxreport_v1.rb +1 -1
- data/generated/google/apis/chromeuxreport_v1/classes.rb +55 -66
- data/generated/google/apis/classroom_v1.rb +1 -1
- data/generated/google/apis/classroom_v1/classes.rb +250 -365
- data/generated/google/apis/classroom_v1/service.rb +643 -902
- data/generated/google/apis/cloudasset_v1.rb +1 -1
- data/generated/google/apis/cloudasset_v1/classes.rb +15 -11
- data/generated/google/apis/cloudasset_v1/service.rb +62 -45
- data/generated/google/apis/cloudasset_v1beta1.rb +1 -1
- data/generated/google/apis/cloudasset_v1beta1/classes.rb +3 -1
- data/generated/google/apis/cloudasset_v1p4beta1.rb +1 -1
- data/generated/google/apis/cloudasset_v1p5beta1.rb +1 -1
- data/generated/google/apis/cloudasset_v1p5beta1/classes.rb +3 -1
- data/generated/google/apis/clouderrorreporting_v1beta1.rb +1 -1
- data/generated/google/apis/clouderrorreporting_v1beta1/classes.rb +7 -0
- data/generated/google/apis/clouderrorreporting_v1beta1/representations.rb +1 -0
- data/generated/google/apis/cloudsearch_v1.rb +1 -1
- data/generated/google/apis/cloudsearch_v1/classes.rb +1 -2
- data/generated/google/apis/compute_alpha.rb +1 -1
- data/generated/google/apis/compute_alpha/classes.rb +350 -20
- data/generated/google/apis/compute_alpha/representations.rb +100 -0
- data/generated/google/apis/compute_alpha/service.rb +15 -7
- data/generated/google/apis/compute_beta.rb +1 -1
- data/generated/google/apis/compute_beta/classes.rb +39 -14
- data/generated/google/apis/compute_beta/representations.rb +2 -0
- data/generated/google/apis/compute_beta/service.rb +15 -7
- data/generated/google/apis/compute_v1.rb +1 -1
- data/generated/google/apis/compute_v1/classes.rb +65 -42
- data/generated/google/apis/compute_v1/representations.rb +18 -15
- data/generated/google/apis/compute_v1/service.rb +63 -19
- data/generated/google/apis/container_v1.rb +1 -1
- data/generated/google/apis/container_v1/classes.rb +26 -0
- data/generated/google/apis/container_v1/representations.rb +15 -0
- data/generated/google/apis/content_v2.rb +1 -1
- data/generated/google/apis/content_v2/classes.rb +9 -0
- data/generated/google/apis/content_v2_1.rb +1 -1
- data/generated/google/apis/content_v2_1/classes.rb +9 -0
- data/generated/google/apis/customsearch_v1.rb +1 -1
- data/generated/google/apis/customsearch_v1/classes.rb +303 -492
- data/generated/google/apis/customsearch_v1/service.rb +184 -341
- data/generated/google/apis/datacatalog_v1beta1.rb +1 -1
- data/generated/google/apis/datacatalog_v1beta1/classes.rb +572 -380
- data/generated/google/apis/datacatalog_v1beta1/service.rb +440 -319
- data/generated/google/apis/datafusion_v1.rb +43 -0
- data/generated/google/apis/datafusion_v1/classes.rb +1154 -0
- data/generated/google/apis/datafusion_v1/representations.rb +390 -0
- data/generated/google/apis/datafusion_v1/service.rb +680 -0
- data/generated/google/apis/dataproc_v1.rb +1 -1
- data/generated/google/apis/dataproc_v1/classes.rb +192 -316
- data/generated/google/apis/dataproc_v1/service.rb +134 -168
- data/generated/google/apis/dataproc_v1beta2.rb +1 -1
- data/generated/google/apis/dataproc_v1beta2/classes.rb +198 -317
- data/generated/google/apis/dataproc_v1beta2/service.rb +137 -192
- data/generated/google/apis/deploymentmanager_alpha.rb +1 -1
- data/generated/google/apis/deploymentmanager_v2beta.rb +1 -1
- data/generated/google/apis/dialogflow_v2.rb +1 -1
- data/generated/google/apis/dialogflow_v2/classes.rb +1238 -1589
- data/generated/google/apis/dialogflow_v2/service.rb +324 -448
- data/generated/google/apis/dialogflow_v2beta1.rb +1 -1
- data/generated/google/apis/dialogflow_v2beta1/classes.rb +1313 -1681
- data/generated/google/apis/dialogflow_v2beta1/service.rb +742 -998
- data/generated/google/apis/displayvideo_v1.rb +1 -1
- data/generated/google/apis/displayvideo_v1/classes.rb +104 -0
- data/generated/google/apis/displayvideo_v1/representations.rb +36 -0
- data/generated/google/apis/displayvideo_v1/service.rb +104 -0
- data/generated/google/apis/dlp_v2.rb +1 -1
- data/generated/google/apis/dlp_v2/classes.rb +5 -4
- data/generated/google/apis/dns_v1.rb +1 -1
- data/generated/google/apis/dns_v1/classes.rb +7 -7
- data/generated/google/apis/dns_v1beta2.rb +1 -1
- data/generated/google/apis/dns_v1beta2/classes.rb +7 -7
- data/generated/google/apis/dns_v2beta1.rb +1 -1
- data/generated/google/apis/dns_v2beta1/classes.rb +7 -7
- data/generated/google/apis/domainsrdap_v1.rb +1 -1
- data/generated/google/apis/domainsrdap_v1/classes.rb +42 -69
- data/generated/google/apis/domainsrdap_v1/service.rb +16 -16
- data/generated/google/apis/doubleclickbidmanager_v1.rb +1 -1
- data/generated/google/apis/doubleclickbidmanager_v1/classes.rb +1 -1
- data/generated/google/apis/doubleclickbidmanager_v1/service.rb +4 -2
- data/generated/google/apis/doubleclickbidmanager_v1_1.rb +1 -1
- data/generated/google/apis/doubleclickbidmanager_v1_1/classes.rb +196 -1
- data/generated/google/apis/doubleclickbidmanager_v1_1/representations.rb +107 -0
- data/generated/google/apis/doubleclickbidmanager_v1_1/service.rb +4 -2
- data/generated/google/apis/drive_v2.rb +1 -1
- data/generated/google/apis/drive_v2/classes.rb +3 -1
- data/generated/google/apis/drive_v3.rb +1 -1
- data/generated/google/apis/drive_v3/classes.rb +9 -1
- data/generated/google/apis/drive_v3/representations.rb +1 -0
- data/generated/google/apis/driveactivity_v2.rb +1 -1
- data/generated/google/apis/driveactivity_v2/classes.rb +55 -68
- data/generated/google/apis/factchecktools_v1alpha1.rb +1 -1
- data/generated/google/apis/factchecktools_v1alpha1/classes.rb +46 -56
- data/generated/google/apis/factchecktools_v1alpha1/service.rb +30 -33
- data/generated/google/apis/firebase_v1beta1.rb +1 -1
- data/generated/google/apis/firebase_v1beta1/classes.rb +313 -345
- data/generated/google/apis/firebase_v1beta1/representations.rb +1 -0
- data/generated/google/apis/firebase_v1beta1/service.rb +356 -420
- data/generated/google/apis/firebasedynamiclinks_v1.rb +1 -1
- data/generated/google/apis/firebasedynamiclinks_v1/classes.rb +89 -112
- data/generated/google/apis/firebasedynamiclinks_v1/service.rb +18 -21
- data/generated/google/apis/firebasehosting_v1.rb +1 -1
- data/generated/google/apis/firebasehosting_v1/classes.rb +36 -40
- data/generated/google/apis/firebasehosting_v1/service.rb +19 -22
- data/generated/google/apis/firebasehosting_v1beta1.rb +1 -1
- data/generated/google/apis/firebasehosting_v1beta1/classes.rb +148 -177
- data/generated/google/apis/firebasehosting_v1beta1/service.rb +112 -145
- data/generated/google/apis/firebaseml_v1.rb +1 -1
- data/generated/google/apis/firebaseml_v1/classes.rb +39 -44
- data/generated/google/apis/firebaseml_v1/service.rb +19 -22
- data/generated/google/apis/firebaseml_v1beta2.rb +1 -1
- data/generated/google/apis/firebaseml_v1beta2/classes.rb +60 -70
- data/generated/google/apis/firebaseml_v1beta2/service.rb +16 -18
- data/generated/google/apis/gameservices_v1.rb +1 -1
- data/generated/google/apis/gameservices_v1/classes.rb +344 -523
- data/generated/google/apis/gameservices_v1/service.rb +167 -207
- data/generated/google/apis/gameservices_v1beta.rb +1 -1
- data/generated/google/apis/gameservices_v1beta/classes.rb +344 -523
- data/generated/google/apis/gameservices_v1beta/service.rb +167 -207
- data/generated/google/apis/genomics_v1.rb +1 -1
- data/generated/google/apis/genomics_v1alpha2.rb +1 -1
- data/generated/google/apis/genomics_v2alpha1.rb +1 -1
- data/generated/google/apis/genomics_v2alpha1/classes.rb +3 -75
- data/generated/google/apis/genomics_v2alpha1/representations.rb +0 -27
- data/generated/google/apis/genomics_v2alpha1/service.rb +0 -34
- data/generated/google/apis/gmail_v1.rb +3 -3
- data/generated/google/apis/gmail_v1/classes.rb +216 -269
- data/generated/google/apis/gmail_v1/service.rb +257 -286
- data/generated/google/apis/gmailpostmastertools_v1beta1.rb +1 -1
- data/generated/google/apis/gmailpostmastertools_v1beta1/classes.rb +37 -42
- data/generated/google/apis/gmailpostmastertools_v1beta1/service.rb +34 -40
- data/generated/google/apis/healthcare_v1.rb +1 -1
- data/generated/google/apis/healthcare_v1/service.rb +26 -14
- data/generated/google/apis/healthcare_v1beta1.rb +1 -1
- data/generated/google/apis/healthcare_v1beta1/classes.rb +85 -17
- data/generated/google/apis/healthcare_v1beta1/representations.rb +39 -0
- data/generated/google/apis/healthcare_v1beta1/service.rb +87 -16
- data/generated/google/apis/language_v1.rb +1 -1
- data/generated/google/apis/language_v1/classes.rb +93 -111
- data/generated/google/apis/language_v1/service.rb +4 -4
- data/generated/google/apis/language_v1beta1.rb +1 -1
- data/generated/google/apis/language_v1beta1/classes.rb +78 -90
- data/generated/google/apis/language_v1beta1/service.rb +2 -2
- data/generated/google/apis/language_v1beta2.rb +1 -1
- data/generated/google/apis/language_v1beta2/classes.rb +95 -112
- data/generated/google/apis/language_v1beta2/service.rb +4 -4
- data/generated/google/apis/libraryagent_v1.rb +1 -1
- data/generated/google/apis/libraryagent_v1/classes.rb +10 -16
- data/generated/google/apis/libraryagent_v1/service.rb +13 -16
- data/generated/google/apis/logging_v2.rb +1 -1
- data/generated/google/apis/logging_v2/classes.rb +6 -6
- data/generated/google/apis/managedidentities_v1.rb +1 -1
- data/generated/google/apis/managedidentities_v1/classes.rb +326 -452
- data/generated/google/apis/managedidentities_v1/service.rb +78 -99
- data/generated/google/apis/managedidentities_v1alpha1.rb +1 -1
- data/generated/google/apis/managedidentities_v1alpha1/classes.rb +336 -457
- data/generated/google/apis/managedidentities_v1alpha1/service.rb +88 -112
- data/generated/google/apis/managedidentities_v1beta1.rb +1 -1
- data/generated/google/apis/managedidentities_v1beta1/classes.rb +332 -456
- data/generated/google/apis/managedidentities_v1beta1/service.rb +76 -96
- data/generated/google/apis/memcache_v1.rb +35 -0
- data/generated/google/apis/memcache_v1/classes.rb +1157 -0
- data/generated/google/apis/memcache_v1/representations.rb +471 -0
- data/generated/google/apis/memcache_v1/service.rb +558 -0
- data/generated/google/apis/memcache_v1beta2.rb +1 -1
- data/generated/google/apis/memcache_v1beta2/classes.rb +41 -502
- data/generated/google/apis/memcache_v1beta2/representations.rb +9 -110
- data/generated/google/apis/memcache_v1beta2/service.rb +0 -119
- data/generated/google/apis/monitoring_v1.rb +1 -1
- data/generated/google/apis/monitoring_v1/classes.rb +12 -11
- data/generated/google/apis/monitoring_v3.rb +1 -1
- data/generated/google/apis/monitoring_v3/classes.rb +31 -14
- data/generated/google/apis/monitoring_v3/representations.rb +2 -0
- data/generated/google/apis/osconfig_v1.rb +1 -1
- data/generated/google/apis/osconfig_v1/classes.rb +721 -0
- data/generated/google/apis/osconfig_v1/representations.rb +337 -0
- data/generated/google/apis/people_v1.rb +1 -1
- data/generated/google/apis/people_v1/classes.rb +148 -13
- data/generated/google/apis/people_v1/representations.rb +57 -0
- data/generated/google/apis/people_v1/service.rb +60 -48
- data/generated/google/apis/playcustomapp_v1.rb +1 -1
- data/generated/google/apis/playcustomapp_v1/classes.rb +2 -2
- data/generated/google/apis/policytroubleshooter_v1.rb +1 -1
- data/generated/google/apis/policytroubleshooter_v1/classes.rb +232 -394
- data/generated/google/apis/policytroubleshooter_v1/service.rb +2 -2
- data/generated/google/apis/policytroubleshooter_v1beta.rb +1 -1
- data/generated/google/apis/policytroubleshooter_v1beta/classes.rb +232 -393
- data/generated/google/apis/policytroubleshooter_v1beta/service.rb +2 -2
- data/generated/google/apis/prod_tt_sasportal_v1alpha1.rb +1 -1
- data/generated/google/apis/prod_tt_sasportal_v1alpha1/classes.rb +122 -146
- data/generated/google/apis/prod_tt_sasportal_v1alpha1/service.rb +38 -49
- data/generated/google/apis/realtimebidding_v1.rb +1 -4
- data/generated/google/apis/realtimebidding_v1/classes.rb +198 -291
- data/generated/google/apis/realtimebidding_v1/service.rb +98 -135
- data/generated/google/apis/recommendationengine_v1beta1.rb +2 -2
- data/generated/google/apis/recommendationengine_v1beta1/classes.rb +10 -8
- data/generated/google/apis/recommendationengine_v1beta1/service.rb +1 -1
- data/generated/google/apis/recommender_v1.rb +1 -1
- data/generated/google/apis/recommender_v1/classes.rb +76 -100
- data/generated/google/apis/recommender_v1/service.rb +43 -58
- data/generated/google/apis/recommender_v1beta1.rb +1 -1
- data/generated/google/apis/recommender_v1beta1/classes.rb +75 -99
- data/generated/google/apis/recommender_v1beta1/service.rb +43 -58
- data/generated/google/apis/run_v1.rb +1 -1
- data/generated/google/apis/run_v1/classes.rb +2 -2
- data/generated/google/apis/run_v1/service.rb +38 -2
- data/generated/google/apis/runtimeconfig_v1.rb +1 -1
- data/generated/google/apis/runtimeconfig_v1/classes.rb +36 -40
- data/generated/google/apis/runtimeconfig_v1/service.rb +19 -22
- data/generated/google/apis/sasportal_v1alpha1.rb +1 -1
- data/generated/google/apis/sasportal_v1alpha1/classes.rb +122 -146
- data/generated/google/apis/sasportal_v1alpha1/service.rb +38 -49
- data/generated/google/apis/searchconsole_v1.rb +1 -1
- data/generated/google/apis/searchconsole_v1/classes.rb +2 -2
- data/generated/google/apis/securitycenter_v1.rb +1 -1
- data/generated/google/apis/securitycenter_v1/classes.rb +574 -826
- data/generated/google/apis/securitycenter_v1/service.rb +250 -332
- data/generated/google/apis/securitycenter_v1beta1.rb +1 -1
- data/generated/google/apis/securitycenter_v1beta1/classes.rb +521 -746
- data/generated/google/apis/securitycenter_v1beta1/service.rb +160 -202
- data/generated/google/apis/securitycenter_v1p1alpha1.rb +1 -1
- data/generated/google/apis/securitycenter_v1p1alpha1/classes.rb +176 -208
- data/generated/google/apis/securitycenter_v1p1alpha1/service.rb +21 -25
- data/generated/google/apis/securitycenter_v1p1beta1.rb +1 -1
- data/generated/google/apis/securitycenter_v1p1beta1/classes.rb +545 -791
- data/generated/google/apis/securitycenter_v1p1beta1/service.rb +247 -330
- data/generated/google/apis/serviceconsumermanagement_v1.rb +1 -1
- data/generated/google/apis/serviceconsumermanagement_v1/classes.rb +1149 -1783
- data/generated/google/apis/serviceconsumermanagement_v1/service.rb +111 -138
- data/generated/google/apis/serviceconsumermanagement_v1beta1.rb +1 -1
- data/generated/google/apis/serviceconsumermanagement_v1beta1/classes.rb +1137 -1774
- data/generated/google/apis/serviceconsumermanagement_v1beta1/service.rb +52 -66
- data/generated/google/apis/servicecontrol_v2.rb +38 -0
- data/generated/google/apis/servicecontrol_v2/classes.rb +1121 -0
- data/generated/google/apis/servicecontrol_v2/representations.rb +405 -0
- data/generated/google/apis/servicecontrol_v2/service.rb +165 -0
- data/generated/google/apis/servicemanagement_v1.rb +1 -1
- data/generated/google/apis/servicemanagement_v1/classes.rb +49 -1
- data/generated/google/apis/servicemanagement_v1/representations.rb +14 -0
- data/generated/google/apis/servicenetworking_v1.rb +1 -1
- data/generated/google/apis/servicenetworking_v1/classes.rb +1119 -1758
- data/generated/google/apis/servicenetworking_v1/service.rb +94 -114
- data/generated/google/apis/servicenetworking_v1beta.rb +1 -1
- data/generated/google/apis/servicenetworking_v1beta/classes.rb +1065 -1684
- data/generated/google/apis/servicenetworking_v1beta/service.rb +52 -63
- data/generated/google/apis/serviceusage_v1.rb +1 -1
- data/generated/google/apis/serviceusage_v1/classes.rb +1140 -1823
- data/generated/google/apis/serviceusage_v1/service.rb +63 -80
- data/generated/google/apis/serviceusage_v1beta1.rb +1 -1
- data/generated/google/apis/serviceusage_v1beta1/classes.rb +1235 -1986
- data/generated/google/apis/serviceusage_v1beta1/service.rb +130 -162
- data/generated/google/apis/spanner_v1.rb +1 -1
- data/generated/google/apis/spanner_v1/classes.rb +3 -2
- data/generated/google/apis/storagetransfer_v1.rb +1 -1
- data/generated/google/apis/storagetransfer_v1/classes.rb +8 -10
- data/generated/google/apis/storagetransfer_v1/service.rb +26 -2
- data/generated/google/apis/tagmanager_v1.rb +2 -3
- data/generated/google/apis/tagmanager_v1/classes.rb +225 -288
- data/generated/google/apis/tagmanager_v1/service.rb +20 -21
- data/generated/google/apis/tagmanager_v2.rb +2 -3
- data/generated/google/apis/tagmanager_v2/classes.rb +240 -280
- data/generated/google/apis/tagmanager_v2/representations.rb +1 -0
- data/generated/google/apis/tagmanager_v2/service.rb +187 -283
- data/generated/google/apis/toolresults_v1beta3.rb +1 -1
- data/generated/google/apis/toolresults_v1beta3/classes.rb +665 -931
- data/generated/google/apis/toolresults_v1beta3/service.rb +231 -349
- data/generated/google/apis/tpu_v1.rb +1 -1
- data/generated/google/apis/tpu_v1/classes.rb +68 -78
- data/generated/google/apis/tpu_v1/service.rb +21 -25
- data/generated/google/apis/tpu_v1alpha1.rb +1 -1
- data/generated/google/apis/tpu_v1alpha1/classes.rb +68 -78
- data/generated/google/apis/tpu_v1alpha1/service.rb +21 -25
- data/generated/google/apis/translate_v3.rb +1 -1
- data/generated/google/apis/translate_v3/service.rb +14 -1
- data/generated/google/apis/translate_v3beta1.rb +1 -1
- data/generated/google/apis/translate_v3beta1/service.rb +14 -1
- data/generated/google/apis/vision_v1.rb +1 -1
- data/generated/google/apis/vision_v1/classes.rb +1304 -1870
- data/generated/google/apis/vision_v1/service.rb +254 -340
- data/generated/google/apis/vision_v1p1beta1.rb +1 -1
- data/generated/google/apis/vision_v1p1beta1/classes.rb +1246 -1790
- data/generated/google/apis/vision_v1p1beta1/service.rb +91 -121
- data/generated/google/apis/vision_v1p2beta1.rb +1 -1
- data/generated/google/apis/vision_v1p2beta1/classes.rb +1246 -1790
- data/generated/google/apis/vision_v1p2beta1/service.rb +91 -121
- data/generated/google/apis/websecurityscanner_v1.rb +1 -1
- data/generated/google/apis/websecurityscanner_v1/classes.rb +71 -95
- data/generated/google/apis/websecurityscanner_v1/service.rb +46 -65
- data/generated/google/apis/websecurityscanner_v1alpha.rb +1 -1
- data/generated/google/apis/websecurityscanner_v1alpha/classes.rb +55 -63
- data/generated/google/apis/websecurityscanner_v1alpha/service.rb +46 -65
- data/generated/google/apis/websecurityscanner_v1beta.rb +1 -1
- data/generated/google/apis/websecurityscanner_v1beta/classes.rb +77 -92
- data/generated/google/apis/websecurityscanner_v1beta/service.rb +46 -65
- data/generated/google/apis/youtube_analytics_v2.rb +1 -1
- data/generated/google/apis/youtube_analytics_v2/classes.rb +77 -104
- data/generated/google/apis/youtube_analytics_v2/service.rb +106 -126
- data/generated/google/apis/youtube_partner_v1.rb +1 -1
- data/generated/google/apis/youtube_partner_v1/service.rb +19 -19
- data/generated/google/apis/youtube_v3.rb +1 -1
- data/generated/google/apis/youtube_v3/classes.rb +937 -1175
- data/generated/google/apis/youtube_v3/service.rb +975 -1284
- data/generated/google/apis/youtubereporting_v1.rb +1 -1
- data/generated/google/apis/youtubereporting_v1/classes.rb +20 -29
- data/generated/google/apis/youtubereporting_v1/service.rb +40 -43
- data/lib/google/apis/core/base_service.rb +7 -1
- data/lib/google/apis/version.rb +1 -1
- metadata +15 -7
- data/generated/google/apis/fitness_v1.rb +0 -85
- data/generated/google/apis/fitness_v1/classes.rb +0 -1020
- data/generated/google/apis/fitness_v1/representations.rb +0 -398
- data/generated/google/apis/fitness_v1/service.rb +0 -647
|
@@ -47,15 +47,13 @@ module Google
|
|
|
47
47
|
@batch_path = 'batch'
|
|
48
48
|
end
|
|
49
49
|
|
|
50
|
-
# Starts asynchronous cancellation on a long-running operation.
|
|
51
|
-
#
|
|
52
|
-
#
|
|
53
|
-
#
|
|
54
|
-
#
|
|
55
|
-
#
|
|
56
|
-
# operation
|
|
57
|
-
# the operation is not deleted; instead, it becomes an operation with
|
|
58
|
-
# an Operation.error value with a google.rpc.Status.code of 1,
|
|
50
|
+
# Starts asynchronous cancellation on a long-running operation. The server makes
|
|
51
|
+
# a best effort to cancel the operation, but success is not guaranteed. If the
|
|
52
|
+
# server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
|
|
53
|
+
# Clients can use Operations.GetOperation or other methods to check whether the
|
|
54
|
+
# cancellation succeeded or whether the operation completed despite cancellation.
|
|
55
|
+
# On successful cancellation, the operation is not deleted; instead, it becomes
|
|
56
|
+
# an operation with an Operation.error value with a google.rpc.Status.code of 1,
|
|
59
57
|
# corresponding to `Code.CANCELLED`.
|
|
60
58
|
# @param [String] name
|
|
61
59
|
# The name of the operation resource to be cancelled.
|
|
@@ -89,10 +87,10 @@ module Google
|
|
|
89
87
|
execute_or_queue_command(command, &block)
|
|
90
88
|
end
|
|
91
89
|
|
|
92
|
-
# Deletes a long-running operation. This method indicates that the client is
|
|
93
|
-
#
|
|
94
|
-
#
|
|
95
|
-
#
|
|
90
|
+
# Deletes a long-running operation. This method indicates that the client is no
|
|
91
|
+
# longer interested in the operation result. It does not cancel the operation.
|
|
92
|
+
# If the server doesn't support this method, it returns `google.rpc.Code.
|
|
93
|
+
# UNIMPLEMENTED`.
|
|
96
94
|
# @param [String] name
|
|
97
95
|
# The name of the operation resource to be deleted.
|
|
98
96
|
# @param [String] fields
|
|
@@ -122,9 +120,8 @@ module Google
|
|
|
122
120
|
execute_or_queue_command(command, &block)
|
|
123
121
|
end
|
|
124
122
|
|
|
125
|
-
# Gets the latest state of a long-running operation.
|
|
126
|
-
#
|
|
127
|
-
# service.
|
|
123
|
+
# Gets the latest state of a long-running operation. Clients can use this method
|
|
124
|
+
# to poll the operation result at intervals as recommended by the API service.
|
|
128
125
|
# @param [String] name
|
|
129
126
|
# The name of the operation resource.
|
|
130
127
|
# @param [String] fields
|
|
@@ -154,15 +151,14 @@ module Google
|
|
|
154
151
|
execute_or_queue_command(command, &block)
|
|
155
152
|
end
|
|
156
153
|
|
|
157
|
-
# Lists operations that match the specified filter in the request. If the
|
|
158
|
-
#
|
|
159
|
-
#
|
|
160
|
-
#
|
|
161
|
-
#
|
|
162
|
-
#
|
|
163
|
-
#
|
|
164
|
-
#
|
|
165
|
-
# is the parent resource, without the operations collection id.
|
|
154
|
+
# Lists operations that match the specified filter in the request. If the server
|
|
155
|
+
# doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name`
|
|
156
|
+
# binding allows API services to override the binding to use different resource
|
|
157
|
+
# name schemes, such as `users/*/operations`. To override the binding, API
|
|
158
|
+
# services can add a binding such as `"/v1/`name=users/*`/operations"` to their
|
|
159
|
+
# service configuration. For backwards compatibility, the default name includes
|
|
160
|
+
# the operations collection id, however overriding users must ensure the name
|
|
161
|
+
# binding is the parent resource, without the operations collection id.
|
|
166
162
|
# @param [String] name
|
|
167
163
|
# The name of the operation's parent resource.
|
|
168
164
|
# @param [String] filter
|
|
@@ -203,33 +199,28 @@ module Google
|
|
|
203
199
|
|
|
204
200
|
# Search tenancy units for a managed service.
|
|
205
201
|
# @param [String] parent
|
|
206
|
-
# Service for which search is performed.
|
|
207
|
-
#
|
|
208
|
-
# `service` the name of a service, for example 'service.googleapis.com'.
|
|
202
|
+
# Service for which search is performed. services/`service` `service` the name
|
|
203
|
+
# of a service, for example 'service.googleapis.com'.
|
|
209
204
|
# @param [Fixnum] page_size
|
|
210
205
|
# Optional. The maximum number of results returned by this request. Currently,
|
|
211
|
-
# the
|
|
212
|
-
# default maximum is set to 1000. If `page_size` isn't provided or the size
|
|
206
|
+
# the default maximum is set to 1000. If `page_size` isn't provided or the size
|
|
213
207
|
# provided is a number larger than 1000, it's automatically set to 1000.
|
|
214
208
|
# @param [String] page_token
|
|
215
209
|
# Optional. The continuation token, which is used to page through large result
|
|
216
|
-
# sets.
|
|
217
|
-
#
|
|
218
|
-
# `nextPageToken` from the previous response.
|
|
210
|
+
# sets. To get the next page of results, set this parameter to the value of `
|
|
211
|
+
# nextPageToken` from the previous response.
|
|
219
212
|
# @param [String] query
|
|
220
213
|
# Optional. Set a query ``expression`` for querying tenancy units. Your ``
|
|
221
|
-
# expression``
|
|
222
|
-
#
|
|
223
|
-
#
|
|
224
|
-
#
|
|
225
|
-
#
|
|
226
|
-
# resource with a given
|
|
227
|
-
#
|
|
228
|
-
#
|
|
229
|
-
# `tenant_resources.
|
|
230
|
-
#
|
|
231
|
-
# all expressions to be included in the result set. For example,
|
|
232
|
-
# `tenant_resources.tag=xyz AND tenant_resources.resource=projects/123456`
|
|
214
|
+
# expression`` must be in the format: `field_name=literal_string`. The `
|
|
215
|
+
# field_name` is the name of the field you want to compare. Supported fields are
|
|
216
|
+
# `tenant_resources.tag` and `tenant_resources.resource`. For example, to search
|
|
217
|
+
# tenancy units that contain at least one tenant resource with a given tag 'xyz',
|
|
218
|
+
# use the query `tenant_resources.tag=xyz`. To search tenancy units that
|
|
219
|
+
# contain at least one tenant resource with a given resource name 'projects/
|
|
220
|
+
# 123456', use the query `tenant_resources.resource=projects/123456`. Multiple
|
|
221
|
+
# expressions can be joined with `AND`s. Tenancy units must match all
|
|
222
|
+
# expressions to be included in the result set. For example, `tenant_resources.
|
|
223
|
+
# tag=xyz AND tenant_resources.resource=projects/123456`
|
|
233
224
|
# @param [String] fields
|
|
234
225
|
# Selector specifying which fields to include in a partial response.
|
|
235
226
|
# @param [String] quota_user
|
|
@@ -260,15 +251,14 @@ module Google
|
|
|
260
251
|
execute_or_queue_command(command, &block)
|
|
261
252
|
end
|
|
262
253
|
|
|
263
|
-
# Add a new tenant project to the tenancy unit.
|
|
264
|
-
#
|
|
265
|
-
#
|
|
266
|
-
#
|
|
267
|
-
#
|
|
268
|
-
# Operation<response: Empty>.
|
|
254
|
+
# Add a new tenant project to the tenancy unit. There can be a maximum of 512
|
|
255
|
+
# tenant projects in a tenancy unit. If there are previously failed `
|
|
256
|
+
# AddTenantProject` calls, you might need to call `RemoveTenantProject` first to
|
|
257
|
+
# resolve them before you can make another call to `AddTenantProject` with the
|
|
258
|
+
# same tag. Operation.
|
|
269
259
|
# @param [String] parent
|
|
270
|
-
# Name of the tenancy unit.
|
|
271
|
-
#
|
|
260
|
+
# Name of the tenancy unit. Such as 'services/service.googleapis.com/projects/
|
|
261
|
+
# 12345/tenancyUnits/abcd'.
|
|
272
262
|
# @param [Google::Apis::ServiceconsumermanagementV1::AddTenantProjectRequest] add_tenant_project_request_object
|
|
273
263
|
# @param [String] fields
|
|
274
264
|
# Selector specifying which fields to include in a partial response.
|
|
@@ -299,26 +289,22 @@ module Google
|
|
|
299
289
|
execute_or_queue_command(command, &block)
|
|
300
290
|
end
|
|
301
291
|
|
|
302
|
-
# Apply a configuration to an existing tenant project.
|
|
303
|
-
#
|
|
304
|
-
#
|
|
305
|
-
#
|
|
306
|
-
#
|
|
307
|
-
#
|
|
308
|
-
#
|
|
309
|
-
#
|
|
310
|
-
# Omit a billing configuration to keep the existing one.
|
|
311
|
-
# A service account in the project is created if previously non existed.
|
|
292
|
+
# Apply a configuration to an existing tenant project. This project must exist
|
|
293
|
+
# in an active state and have the original owner account. The caller must have
|
|
294
|
+
# permission to add a project to the given tenancy unit. The configuration is
|
|
295
|
+
# applied, but any existing settings on the project aren't modified. Specified
|
|
296
|
+
# policy bindings are applied. Existing bindings aren't modified. Specified
|
|
297
|
+
# services are activated. No service is deactivated. If specified, new billing
|
|
298
|
+
# configuration is applied. Omit a billing configuration to keep the existing
|
|
299
|
+
# one. A service account in the project is created if previously non existed.
|
|
312
300
|
# Specified labels will be appended to tenant project, note that the value of
|
|
313
|
-
# existing label key will be updated if the same label key is requested.
|
|
314
|
-
#
|
|
315
|
-
#
|
|
316
|
-
#
|
|
317
|
-
# applied configuration changes is attempted.
|
|
318
|
-
# Operation<response: Empty>.
|
|
301
|
+
# existing label key will be updated if the same label key is requested. The
|
|
302
|
+
# specified folder is ignored, as moving a tenant project to a different folder
|
|
303
|
+
# isn't supported. The operation fails if any of the steps fail, but no rollback
|
|
304
|
+
# of already applied configuration changes is attempted. Operation.
|
|
319
305
|
# @param [String] name
|
|
320
|
-
# Name of the tenancy unit.
|
|
321
|
-
#
|
|
306
|
+
# Name of the tenancy unit. Such as 'services/service.googleapis.com/projects/
|
|
307
|
+
# 12345/tenancyUnits/abcd'.
|
|
322
308
|
# @param [Google::Apis::ServiceconsumermanagementV1::ApplyTenantProjectConfigRequest] apply_tenant_project_config_request_object
|
|
323
309
|
# @param [String] fields
|
|
324
310
|
# Selector specifying which fields to include in a partial response.
|
|
@@ -349,20 +335,18 @@ module Google
|
|
|
349
335
|
execute_or_queue_command(command, &block)
|
|
350
336
|
end
|
|
351
337
|
|
|
352
|
-
# Attach an existing project to the tenancy unit as a new tenant
|
|
353
|
-
#
|
|
354
|
-
#
|
|
355
|
-
#
|
|
356
|
-
#
|
|
357
|
-
#
|
|
358
|
-
#
|
|
359
|
-
#
|
|
360
|
-
#
|
|
361
|
-
# if the project is reserved by calling `AddTenantProject`.
|
|
362
|
-
# Operation<response: Empty>.
|
|
338
|
+
# Attach an existing project to the tenancy unit as a new tenant resource. The
|
|
339
|
+
# project could either be the tenant project reserved by calling `
|
|
340
|
+
# AddTenantProject` under a tenancy unit of a service producer's project of a
|
|
341
|
+
# managed service, or from a separate project. The caller is checked against a
|
|
342
|
+
# set of permissions as if calling `AddTenantProject` on the same service
|
|
343
|
+
# consumer. To trigger the attachment, the targeted tenant project must be in a
|
|
344
|
+
# folder. Make sure the ServiceConsumerManagement service account is the owner
|
|
345
|
+
# of that project. These two requirements are already met if the project is
|
|
346
|
+
# reserved by calling `AddTenantProject`. Operation.
|
|
363
347
|
# @param [String] name
|
|
364
|
-
# Name of the tenancy unit that the project will be attached to.
|
|
365
|
-
#
|
|
348
|
+
# Name of the tenancy unit that the project will be attached to. Such as '
|
|
349
|
+
# services/service.googleapis.com/projects/12345/tenancyUnits/abcd'.
|
|
366
350
|
# @param [Google::Apis::ServiceconsumermanagementV1::AttachTenantProjectRequest] attach_tenant_project_request_object
|
|
367
351
|
# @param [String] fields
|
|
368
352
|
# Selector specifying which fields to include in a partial response.
|
|
@@ -393,18 +377,16 @@ module Google
|
|
|
393
377
|
execute_or_queue_command(command, &block)
|
|
394
378
|
end
|
|
395
379
|
|
|
396
|
-
# Creates a tenancy unit with no tenant resources.
|
|
397
|
-
#
|
|
398
|
-
#
|
|
399
|
-
#
|
|
400
|
-
# TenancyUnit with all fields populated.
|
|
380
|
+
# Creates a tenancy unit with no tenant resources. If tenancy unit already
|
|
381
|
+
# exists, it will be returned, however, in this case, returned TenancyUnit does
|
|
382
|
+
# not have tenant_resources field set and ListTenancyUnits has to be used to get
|
|
383
|
+
# a complete TenancyUnit with all fields populated.
|
|
401
384
|
# @param [String] parent
|
|
402
|
-
# services/`service`/`collection id`/`resource id`
|
|
403
|
-
#
|
|
404
|
-
#
|
|
405
|
-
#
|
|
406
|
-
#
|
|
407
|
-
# Enables service binding using the new tenancy unit.
|
|
385
|
+
# services/`service`/`collection id`/`resource id` `collection id` is the cloud
|
|
386
|
+
# resource collection type representing the service consumer, for example '
|
|
387
|
+
# projects', or 'organizations'. `resource id` is the consumer numeric id, such
|
|
388
|
+
# as project number: '123456'. `service` the name of a managed service, such as '
|
|
389
|
+
# service.googleapis.com'. Enables service binding using the new tenancy unit.
|
|
408
390
|
# @param [Google::Apis::ServiceconsumermanagementV1::CreateTenancyUnitRequest] create_tenancy_unit_request_object
|
|
409
391
|
# @param [String] fields
|
|
410
392
|
# Selector specifying which fields to include in a partial response.
|
|
@@ -435,9 +417,8 @@ module Google
|
|
|
435
417
|
execute_or_queue_command(command, &block)
|
|
436
418
|
end
|
|
437
419
|
|
|
438
|
-
# Delete a tenancy unit. Before you delete the tenancy unit, there should be
|
|
439
|
-
#
|
|
440
|
-
# Operation<response: Empty>.
|
|
420
|
+
# Delete a tenancy unit. Before you delete the tenancy unit, there should be no
|
|
421
|
+
# tenant resources in it that aren't in a DELETED state. Operation.
|
|
441
422
|
# @param [String] name
|
|
442
423
|
# Name of the tenancy unit to be deleted.
|
|
443
424
|
# @param [String] fields
|
|
@@ -470,16 +451,13 @@ module Google
|
|
|
470
451
|
# Deletes the specified project resource identified by a tenant resource tag.
|
|
471
452
|
# The mothod removes a project lien with a 'TenantManager' origin if that was
|
|
472
453
|
# added. It will then attempt to delete the project. If that operation fails,
|
|
473
|
-
# this method also fails.
|
|
474
|
-
#
|
|
475
|
-
#
|
|
476
|
-
#
|
|
477
|
-
# New resources with the same tag can't be added if there are existing
|
|
478
|
-
# resources in a DELETED state.
|
|
479
|
-
# Operation<response: Empty>.
|
|
454
|
+
# this method also fails. After the project has been deleted, the tenant
|
|
455
|
+
# resource state is set to DELETED. To permanently remove resource metadata,
|
|
456
|
+
# call the `RemoveTenantProject` method. New resources with the same tag can't
|
|
457
|
+
# be added if there are existing resources in a DELETED state. Operation.
|
|
480
458
|
# @param [String] name
|
|
481
|
-
# Name of the tenancy unit.
|
|
482
|
-
#
|
|
459
|
+
# Name of the tenancy unit. Such as 'services/service.googleapis.com/projects/
|
|
460
|
+
# 12345/tenancyUnits/abcd'.
|
|
483
461
|
# @param [Google::Apis::ServiceconsumermanagementV1::DeleteTenantProjectRequest] delete_tenant_project_request_object
|
|
484
462
|
# @param [String] fields
|
|
485
463
|
# Selector specifying which fields to include in a partial response.
|
|
@@ -510,26 +488,24 @@ module Google
|
|
|
510
488
|
execute_or_queue_command(command, &block)
|
|
511
489
|
end
|
|
512
490
|
|
|
513
|
-
# Find the tenancy unit for a managed service and service consumer.
|
|
514
|
-
#
|
|
515
|
-
#
|
|
516
|
-
#
|
|
517
|
-
# is created.
|
|
491
|
+
# Find the tenancy unit for a managed service and service consumer. This method
|
|
492
|
+
# shouldn't be used in a service producer's runtime path, for example to find
|
|
493
|
+
# the tenant project number when creating VMs. Service producers must persist
|
|
494
|
+
# the tenant project's information after the project is created.
|
|
518
495
|
# @param [String] parent
|
|
519
|
-
# Managed service and service consumer. Required.
|
|
520
|
-
#
|
|
521
|
-
#
|
|
522
|
-
#
|
|
523
|
-
# `
|
|
524
|
-
# `service` the name of a service, such as 'service.googleapis.com'.
|
|
496
|
+
# Managed service and service consumer. Required. services/`service`/`collection
|
|
497
|
+
# id`/`resource id` `collection id` is the cloud resource collection type
|
|
498
|
+
# representing the service consumer, for example 'projects', or 'organizations'.
|
|
499
|
+
# `resource id` is the consumer numeric id, such as project number: '123456'. `
|
|
500
|
+
# service` the name of a service, such as 'service.googleapis.com'.
|
|
525
501
|
# @param [String] filter
|
|
526
502
|
# Filter expression over tenancy resources field. Optional.
|
|
527
503
|
# @param [Fixnum] page_size
|
|
528
504
|
# The maximum number of results returned by this request.
|
|
529
505
|
# @param [String] page_token
|
|
530
|
-
# The continuation token, which is used to page through large result sets.
|
|
531
|
-
#
|
|
532
|
-
#
|
|
506
|
+
# The continuation token, which is used to page through large result sets. To
|
|
507
|
+
# get the next page of results, set this parameter to the value of `
|
|
508
|
+
# nextPageToken` from the previous response.
|
|
533
509
|
# @param [String] fields
|
|
534
510
|
# Selector specifying which fields to include in a partial response.
|
|
535
511
|
# @param [String] quota_user
|
|
@@ -561,16 +537,15 @@ module Google
|
|
|
561
537
|
end
|
|
562
538
|
|
|
563
539
|
# Removes the specified project resource identified by a tenant resource tag.
|
|
564
|
-
# The method removes the project lien with 'TenantManager' origin if that
|
|
565
|
-
#
|
|
566
|
-
#
|
|
567
|
-
#
|
|
568
|
-
#
|
|
569
|
-
#
|
|
570
|
-
# Operation<response: Empty>.
|
|
540
|
+
# The method removes the project lien with 'TenantManager' origin if that was
|
|
541
|
+
# added. It then attempts to delete the project. If that operation fails, this
|
|
542
|
+
# method also fails. Calls to remove already removed or non-existent tenant
|
|
543
|
+
# project succeed. After the project has been deleted, or if was already in a
|
|
544
|
+
# DELETED state, resource metadata is permanently removed from the tenancy unit.
|
|
545
|
+
# Operation.
|
|
571
546
|
# @param [String] name
|
|
572
|
-
# Name of the tenancy unit.
|
|
573
|
-
#
|
|
547
|
+
# Name of the tenancy unit. Such as 'services/service.googleapis.com/projects/
|
|
548
|
+
# 12345/tenancyUnits/abcd'.
|
|
574
549
|
# @param [Google::Apis::ServiceconsumermanagementV1::RemoveTenantProjectRequest] remove_tenant_project_request_object
|
|
575
550
|
# @param [String] fields
|
|
576
551
|
# Selector specifying which fields to include in a partial response.
|
|
@@ -601,16 +576,14 @@ module Google
|
|
|
601
576
|
execute_or_queue_command(command, &block)
|
|
602
577
|
end
|
|
603
578
|
|
|
604
|
-
# Attempts to undelete a previously deleted tenant project. The project must
|
|
605
|
-
#
|
|
606
|
-
#
|
|
607
|
-
# a fully restored and functional state. Call the `ApplyTenantProjectConfig`
|
|
579
|
+
# Attempts to undelete a previously deleted tenant project. The project must be
|
|
580
|
+
# in a DELETED state. There are no guarantees that an undeleted project will be
|
|
581
|
+
# in a fully restored and functional state. Call the `ApplyTenantProjectConfig`
|
|
608
582
|
# method to update its configuration and then validate all managed service
|
|
609
|
-
# resources.
|
|
610
|
-
# Operation<response: Empty>.
|
|
583
|
+
# resources. Operation.
|
|
611
584
|
# @param [String] name
|
|
612
|
-
# Name of the tenancy unit.
|
|
613
|
-
#
|
|
585
|
+
# Name of the tenancy unit. Such as 'services/service.googleapis.com/projects/
|
|
586
|
+
# 12345/tenancyUnits/abcd'.
|
|
614
587
|
# @param [Google::Apis::ServiceconsumermanagementV1::UndeleteTenantProjectRequest] undelete_tenant_project_request_object
|
|
615
588
|
# @param [String] fields
|
|
616
589
|
# Selector specifying which fields to include in a partial response.
|
|
@@ -25,7 +25,7 @@ module Google
|
|
|
25
25
|
# @see https://cloud.google.com/service-consumer-management/docs/overview
|
|
26
26
|
module ServiceconsumermanagementV1beta1
|
|
27
27
|
VERSION = 'V1beta1'
|
|
28
|
-
REVISION = '
|
|
28
|
+
REVISION = '20200801'
|
|
29
29
|
|
|
30
30
|
# View and manage your data across Google Cloud Platform services
|
|
31
31
|
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
|
|
@@ -22,14 +22,13 @@ module Google
|
|
|
22
22
|
module Apis
|
|
23
23
|
module ServiceconsumermanagementV1beta1
|
|
24
24
|
|
|
25
|
-
# Api is a light-weight descriptor for an API Interface.
|
|
26
|
-
#
|
|
27
|
-
#
|
|
28
|
-
#
|
|
29
|
-
#
|
|
30
|
-
#
|
|
31
|
-
#
|
|
32
|
-
# detailed terminology.
|
|
25
|
+
# Api is a light-weight descriptor for an API Interface. Interfaces are also
|
|
26
|
+
# described as "protocol buffer services" in some contexts, such as by the "
|
|
27
|
+
# service" keyword in a .proto file, but they are different from API Services,
|
|
28
|
+
# which represent a concrete implementation of an interface as opposed to simply
|
|
29
|
+
# a description of methods and bindings. They are also sometimes simply referred
|
|
30
|
+
# to as "APIs" in other contexts, such as the name of this message itself. See
|
|
31
|
+
# https://cloud.google.com/apis/design/glossary for detailed terminology.
|
|
33
32
|
class Api
|
|
34
33
|
include Google::Apis::Core::Hashable
|
|
35
34
|
|
|
@@ -43,8 +42,8 @@ module Google
|
|
|
43
42
|
# @return [Array<Google::Apis::ServiceconsumermanagementV1beta1::Mixin>]
|
|
44
43
|
attr_accessor :mixins
|
|
45
44
|
|
|
46
|
-
# The fully qualified name of this interface, including package name
|
|
47
|
-
#
|
|
45
|
+
# The fully qualified name of this interface, including package name followed by
|
|
46
|
+
# the interface's simple name.
|
|
48
47
|
# Corresponds to the JSON property `name`
|
|
49
48
|
# @return [String]
|
|
50
49
|
attr_accessor :name
|
|
@@ -54,8 +53,8 @@ module Google
|
|
|
54
53
|
# @return [Array<Google::Apis::ServiceconsumermanagementV1beta1::Option>]
|
|
55
54
|
attr_accessor :options
|
|
56
55
|
|
|
57
|
-
# `SourceContext` represents information about the source of a
|
|
58
|
-
#
|
|
56
|
+
# `SourceContext` represents information about the source of a protobuf element,
|
|
57
|
+
# like the file in which it is defined.
|
|
59
58
|
# Corresponds to the JSON property `sourceContext`
|
|
60
59
|
# @return [Google::Apis::ServiceconsumermanagementV1beta1::SourceContext]
|
|
61
60
|
attr_accessor :source_context
|
|
@@ -65,23 +64,19 @@ module Google
|
|
|
65
64
|
# @return [String]
|
|
66
65
|
attr_accessor :syntax
|
|
67
66
|
|
|
68
|
-
# A version string for this interface. If specified, must have the form
|
|
69
|
-
#
|
|
70
|
-
#
|
|
71
|
-
#
|
|
72
|
-
#
|
|
73
|
-
#
|
|
74
|
-
#
|
|
75
|
-
#
|
|
76
|
-
#
|
|
77
|
-
#
|
|
78
|
-
#
|
|
79
|
-
#
|
|
80
|
-
#
|
|
81
|
-
# interface, which must end in `v<major-version>`, as in
|
|
82
|
-
# `google.feature.v1`. For major versions 0 and 1, the suffix can
|
|
83
|
-
# be omitted. Zero major versions must only be used for
|
|
84
|
-
# experimental, non-GA interfaces.
|
|
67
|
+
# A version string for this interface. If specified, must have the form `major-
|
|
68
|
+
# version.minor-version`, as in `1.10`. If the minor version is omitted, it
|
|
69
|
+
# defaults to zero. If the entire version field is empty, the major version is
|
|
70
|
+
# derived from the package name, as outlined below. If the field is not empty,
|
|
71
|
+
# the version in the package name will be verified to be consistent with what is
|
|
72
|
+
# provided here. The versioning schema uses [semantic versioning](http://semver.
|
|
73
|
+
# org) where the major version number indicates a breaking change and the minor
|
|
74
|
+
# version an additive, non-breaking change. Both version numbers are signals to
|
|
75
|
+
# users what to expect from different versions, and should be carefully chosen
|
|
76
|
+
# based on the product plan. The major version is also reflected in the package
|
|
77
|
+
# name of the interface, which must end in `v`, as in `google.feature.v1`. For
|
|
78
|
+
# major versions 0 and 1, the suffix can be omitted. Zero major versions must
|
|
79
|
+
# only be used for experimental, non-GA interfaces.
|
|
85
80
|
# Corresponds to the JSON property `version`
|
|
86
81
|
# @return [String]
|
|
87
82
|
attr_accessor :version
|
|
@@ -102,85 +97,63 @@ module Google
|
|
|
102
97
|
end
|
|
103
98
|
end
|
|
104
99
|
|
|
105
|
-
# Configuration for an authentication provider, including support for
|
|
106
|
-
#
|
|
107
|
-
# (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).
|
|
100
|
+
# Configuration for an authentication provider, including support for [JSON Web
|
|
101
|
+
# Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).
|
|
108
102
|
class AuthProvider
|
|
109
103
|
include Google::Apis::Core::Hashable
|
|
110
104
|
|
|
111
|
-
# The list of JWT
|
|
112
|
-
#
|
|
113
|
-
#
|
|
114
|
-
#
|
|
115
|
-
# be accepted.
|
|
116
|
-
# -
|
|
117
|
-
# - "https://[service.name]/"
|
|
118
|
-
# will be accepted.
|
|
119
|
-
# For example, if no audiences are in the setting, LibraryService API will
|
|
120
|
-
# accept JWTs with the following audiences:
|
|
121
|
-
# -
|
|
105
|
+
# The list of JWT [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-
|
|
106
|
+
# web-token-32#section-4.1.3). that are allowed to access. A JWT containing any
|
|
107
|
+
# of these audiences will be accepted. When this setting is absent, JWTs with
|
|
108
|
+
# audiences: - "https://[service.name]/[google.protobuf.Api.name]" - "https://[
|
|
109
|
+
# service.name]/" will be accepted. For example, if no audiences are in the
|
|
110
|
+
# setting, LibraryService API will accept JWTs with the following audiences: -
|
|
122
111
|
# https://library-example.googleapis.com/google.example.library.v1.
|
|
123
|
-
# LibraryService
|
|
124
|
-
#
|
|
125
|
-
#
|
|
126
|
-
# audiences: bookstore_android.apps.googleusercontent.com,
|
|
127
|
-
# bookstore_web.apps.googleusercontent.com
|
|
112
|
+
# LibraryService - https://library-example.googleapis.com/ Example: audiences:
|
|
113
|
+
# bookstore_android.apps.googleusercontent.com, bookstore_web.apps.
|
|
114
|
+
# googleusercontent.com
|
|
128
115
|
# Corresponds to the JSON property `audiences`
|
|
129
116
|
# @return [String]
|
|
130
117
|
attr_accessor :audiences
|
|
131
118
|
|
|
132
|
-
# Redirect URL if JWT token is required but not present or is expired.
|
|
133
|
-
#
|
|
119
|
+
# Redirect URL if JWT token is required but not present or is expired. Implement
|
|
120
|
+
# authorizationUrl of securityDefinitions in OpenAPI spec.
|
|
134
121
|
# Corresponds to the JSON property `authorizationUrl`
|
|
135
122
|
# @return [String]
|
|
136
123
|
attr_accessor :authorization_url
|
|
137
124
|
|
|
138
|
-
# The unique identifier of the auth provider. It will be referred to by
|
|
139
|
-
#
|
|
140
|
-
# Example: "bookstore_auth".
|
|
125
|
+
# The unique identifier of the auth provider. It will be referred to by `
|
|
126
|
+
# AuthRequirement.provider_id`. Example: "bookstore_auth".
|
|
141
127
|
# Corresponds to the JSON property `id`
|
|
142
128
|
# @return [String]
|
|
143
129
|
attr_accessor :id
|
|
144
130
|
|
|
145
|
-
# Identifies the principal that issued the JWT. See
|
|
146
|
-
#
|
|
147
|
-
#
|
|
148
|
-
#
|
|
149
|
-
# Example: 1234567-compute@developer.gserviceaccount.com
|
|
131
|
+
# Identifies the principal that issued the JWT. See https://tools.ietf.org/html/
|
|
132
|
+
# draft-ietf-oauth-json-web-token-32#section-4.1.1 Usually a URL or an email
|
|
133
|
+
# address. Example: https://securetoken.google.com Example: 1234567-compute@
|
|
134
|
+
# developer.gserviceaccount.com
|
|
150
135
|
# Corresponds to the JSON property `issuer`
|
|
151
136
|
# @return [String]
|
|
152
137
|
attr_accessor :issuer
|
|
153
138
|
|
|
154
|
-
# URL of the provider's public key set to validate signature of the JWT. See
|
|
155
|
-
#
|
|
156
|
-
#
|
|
157
|
-
#
|
|
158
|
-
#
|
|
159
|
-
#
|
|
160
|
-
# [OpenID
|
|
161
|
-
# Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html of
|
|
162
|
-
# the issuer.
|
|
163
|
-
# - can be inferred from the email domain of the issuer (e.g. a Google
|
|
164
|
-
# service account).
|
|
165
|
-
# Example: https://www.googleapis.com/oauth2/v1/certs
|
|
139
|
+
# URL of the provider's public key set to validate signature of the JWT. See [
|
|
140
|
+
# OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#
|
|
141
|
+
# ProviderMetadata). Optional if the key set document: - can be retrieved from [
|
|
142
|
+
# OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html
|
|
143
|
+
# of the issuer. - can be inferred from the email domain of the issuer (e.g. a
|
|
144
|
+
# Google service account). Example: https://www.googleapis.com/oauth2/v1/certs
|
|
166
145
|
# Corresponds to the JSON property `jwksUri`
|
|
167
146
|
# @return [String]
|
|
168
147
|
attr_accessor :jwks_uri
|
|
169
148
|
|
|
170
|
-
# Defines the locations to extract the JWT.
|
|
171
|
-
#
|
|
172
|
-
# The
|
|
173
|
-
#
|
|
174
|
-
#
|
|
175
|
-
#
|
|
176
|
-
#
|
|
177
|
-
#
|
|
178
|
-
# Default locations can be specified as followings:
|
|
179
|
-
# jwt_locations:
|
|
180
|
-
# - header: Authorization
|
|
181
|
-
# value_prefix: "Bearer "
|
|
182
|
-
# - header: x-goog-iap-jwt-assertion
|
|
183
|
-
# - query: access_token
|
|
149
|
+
# Defines the locations to extract the JWT. JWT locations can be either from
|
|
150
|
+
# HTTP headers or URL query parameters. The rule is that the first match wins.
|
|
151
|
+
# The checking order is: checking all headers first, then URL query parameters.
|
|
152
|
+
# If not specified, default to use following 3 locations: 1) Authorization:
|
|
153
|
+
# Bearer 2) x-goog-iap-jwt-assertion 3) access_token query parameter Default
|
|
154
|
+
# locations can be specified as followings: jwt_locations: - header:
|
|
155
|
+
# Authorization value_prefix: "Bearer " - header: x-goog-iap-jwt-assertion -
|
|
156
|
+
# query: access_token
|
|
184
157
|
# Corresponds to the JSON property `jwtLocations`
|
|
185
158
|
# @return [Array<Google::Apis::ServiceconsumermanagementV1beta1::JwtLocation>]
|
|
186
159
|
attr_accessor :jwt_locations
|
|
@@ -200,34 +173,26 @@ module Google
|
|
|
200
173
|
end
|
|
201
174
|
end
|
|
202
175
|
|
|
203
|
-
# User-defined authentication requirements, including support for
|
|
204
|
-
#
|
|
205
|
-
# (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).
|
|
176
|
+
# User-defined authentication requirements, including support for [JSON Web
|
|
177
|
+
# Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).
|
|
206
178
|
class AuthRequirement
|
|
207
179
|
include Google::Apis::Core::Hashable
|
|
208
180
|
|
|
209
|
-
# NOTE: This will be deprecated soon, once AuthProvider.audiences is
|
|
210
|
-
#
|
|
211
|
-
#
|
|
212
|
-
#
|
|
213
|
-
#
|
|
214
|
-
#
|
|
215
|
-
#
|
|
216
|
-
# "https://
|
|
217
|
-
#
|
|
218
|
-
#
|
|
219
|
-
# "https://library-example.googleapis.com/google.example.library.v1.
|
|
220
|
-
# LibraryService".
|
|
221
|
-
# Example:
|
|
222
|
-
# audiences: bookstore_android.apps.googleusercontent.com,
|
|
223
|
-
# bookstore_web.apps.googleusercontent.com
|
|
181
|
+
# NOTE: This will be deprecated soon, once AuthProvider.audiences is implemented
|
|
182
|
+
# and accepted in all the runtime components. The list of JWT [audiences](https:/
|
|
183
|
+
# /tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). that
|
|
184
|
+
# are allowed to access. A JWT containing any of these audiences will be
|
|
185
|
+
# accepted. When this setting is absent, only JWTs with audience "https://
|
|
186
|
+
# Service_name/API_name" will be accepted. For example, if no audiences are in
|
|
187
|
+
# the setting, LibraryService API will only accept JWTs with the following
|
|
188
|
+
# audience "https://library-example.googleapis.com/google.example.library.v1.
|
|
189
|
+
# LibraryService". Example: audiences: bookstore_android.apps.googleusercontent.
|
|
190
|
+
# com, bookstore_web.apps.googleusercontent.com
|
|
224
191
|
# Corresponds to the JSON property `audiences`
|
|
225
192
|
# @return [String]
|
|
226
193
|
attr_accessor :audiences
|
|
227
194
|
|
|
228
|
-
# id from authentication provider.
|
|
229
|
-
# Example:
|
|
230
|
-
# provider_id: bookstore_auth
|
|
195
|
+
# id from authentication provider. Example: provider_id: bookstore_auth
|
|
231
196
|
# Corresponds to the JSON property `providerId`
|
|
232
197
|
# @return [String]
|
|
233
198
|
attr_accessor :provider_id
|
|
@@ -243,18 +208,11 @@ module Google
|
|
|
243
208
|
end
|
|
244
209
|
end
|
|
245
210
|
|
|
246
|
-
# `Authentication` defines the authentication configuration for an API.
|
|
247
|
-
#
|
|
248
|
-
#
|
|
249
|
-
#
|
|
250
|
-
#
|
|
251
|
-
# - id: google_calendar_auth
|
|
252
|
-
# jwks_uri: https://www.googleapis.com/oauth2/v1/certs
|
|
253
|
-
# issuer: https://securetoken.google.com
|
|
254
|
-
# rules:
|
|
255
|
-
# - selector: "*"
|
|
256
|
-
# requirements:
|
|
257
|
-
# provider_id: google_calendar_auth
|
|
211
|
+
# `Authentication` defines the authentication configuration for an API. Example
|
|
212
|
+
# for an API targeted for external use: name: calendar.googleapis.com
|
|
213
|
+
# authentication: providers: - id: google_calendar_auth jwks_uri: https://www.
|
|
214
|
+
# googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: -
|
|
215
|
+
# selector: "*" requirements: provider_id: google_calendar_auth
|
|
258
216
|
class Authentication
|
|
259
217
|
include Google::Apis::Core::Hashable
|
|
260
218
|
|
|
@@ -263,8 +221,8 @@ module Google
|
|
|
263
221
|
# @return [Array<Google::Apis::ServiceconsumermanagementV1beta1::AuthProvider>]
|
|
264
222
|
attr_accessor :providers
|
|
265
223
|
|
|
266
|
-
# A list of authentication rules that apply to individual API methods.
|
|
267
|
-
#
|
|
224
|
+
# A list of authentication rules that apply to individual API methods. **NOTE:**
|
|
225
|
+
# All service configuration rules follow "last one wins" order.
|
|
268
226
|
# Corresponds to the JSON property `rules`
|
|
269
227
|
# @return [Array<Google::Apis::ServiceconsumermanagementV1beta1::AuthenticationRule>]
|
|
270
228
|
attr_accessor :rules
|
|
@@ -280,13 +238,11 @@ module Google
|
|
|
280
238
|
end
|
|
281
239
|
end
|
|
282
240
|
|
|
283
|
-
# Authentication rules for the service.
|
|
284
|
-
#
|
|
285
|
-
#
|
|
286
|
-
#
|
|
287
|
-
# request.
|
|
288
|
-
# If a method doesn't have any auth requirements, request credentials will be
|
|
289
|
-
# ignored.
|
|
241
|
+
# Authentication rules for the service. By default, if a method has any
|
|
242
|
+
# authentication requirements, every request must include a valid credential
|
|
243
|
+
# matching one of the requirements. It's an error to include more than one kind
|
|
244
|
+
# of credential in a single request. If a method doesn't have any auth
|
|
245
|
+
# requirements, request credentials will be ignored.
|
|
290
246
|
class AuthenticationRule
|
|
291
247
|
include Google::Apis::Core::Hashable
|
|
292
248
|
|
|
@@ -297,19 +253,18 @@ module Google
|
|
|
297
253
|
alias_method :allow_without_credential?, :allow_without_credential
|
|
298
254
|
|
|
299
255
|
# OAuth scopes are a way to define data and permissions on data. For example,
|
|
300
|
-
# there are scopes defined for "Read-only access to Google Calendar" and
|
|
301
|
-
#
|
|
302
|
-
#
|
|
303
|
-
#
|
|
304
|
-
#
|
|
305
|
-
#
|
|
306
|
-
#
|
|
307
|
-
#
|
|
308
|
-
#
|
|
309
|
-
#
|
|
310
|
-
#
|
|
311
|
-
#
|
|
312
|
-
# due to the backend requiring additional scopes or permissions.
|
|
256
|
+
# there are scopes defined for "Read-only access to Google Calendar" and "Access
|
|
257
|
+
# to Cloud Platform". Users can consent to a scope for an application, giving it
|
|
258
|
+
# permission to access that data on their behalf. OAuth scope specifications
|
|
259
|
+
# should be fairly coarse grained; a user will need to see and understand the
|
|
260
|
+
# text description of what your scope means. In most cases: use one or at most
|
|
261
|
+
# two OAuth scopes for an entire family of products. If your product has
|
|
262
|
+
# multiple APIs, you should probably be sharing the OAuth scope across all of
|
|
263
|
+
# those APIs. When you need finer grained OAuth consent screens: talk with your
|
|
264
|
+
# product management about how developers will use them in practice. Please note
|
|
265
|
+
# that even though each of the canonical scopes is enough for a request to be
|
|
266
|
+
# accepted and passed to the backend, a request can still fail due to the
|
|
267
|
+
# backend requiring additional scopes or permissions.
|
|
313
268
|
# Corresponds to the JSON property `oauth`
|
|
314
269
|
# @return [Google::Apis::ServiceconsumermanagementV1beta1::OAuthRequirements]
|
|
315
270
|
attr_accessor :oauth
|
|
@@ -319,8 +274,8 @@ module Google
|
|
|
319
274
|
# @return [Array<Google::Apis::ServiceconsumermanagementV1beta1::AuthRequirement>]
|
|
320
275
|
attr_accessor :requirements
|
|
321
276
|
|
|
322
|
-
# Selects the methods to which this rule applies.
|
|
323
|
-
#
|
|
277
|
+
# Selects the methods to which this rule applies. Refer to selector for syntax
|
|
278
|
+
# details.
|
|
324
279
|
# Corresponds to the JSON property `selector`
|
|
325
280
|
# @return [String]
|
|
326
281
|
attr_accessor :selector
|
|
@@ -342,8 +297,8 @@ module Google
|
|
|
342
297
|
class Backend
|
|
343
298
|
include Google::Apis::Core::Hashable
|
|
344
299
|
|
|
345
|
-
# A list of API backend rules that apply to individual API methods.
|
|
346
|
-
#
|
|
300
|
+
# A list of API backend rules that apply to individual API methods. **NOTE:**
|
|
301
|
+
# All service configuration rules follow "last one wins" order.
|
|
347
302
|
# Corresponds to the JSON property `rules`
|
|
348
303
|
# @return [Array<Google::Apis::ServiceconsumermanagementV1beta1::BackendRule>]
|
|
349
304
|
attr_accessor :rules
|
|
@@ -362,21 +317,13 @@ module Google
|
|
|
362
317
|
class BackendRule
|
|
363
318
|
include Google::Apis::Core::Hashable
|
|
364
319
|
|
|
365
|
-
# The address of the API backend.
|
|
366
|
-
#
|
|
367
|
-
#
|
|
368
|
-
#
|
|
369
|
-
#
|
|
370
|
-
#
|
|
371
|
-
#
|
|
372
|
-
# grpcs:// gRPC TLS
|
|
373
|
-
# It is recommended to explicitly include a scheme. Leaving out the scheme
|
|
374
|
-
# may cause constrasting behaviors across platforms.
|
|
375
|
-
# If the port is unspecified, the default is:
|
|
376
|
-
# - 80 for schemes without TLS
|
|
377
|
-
# - 443 for schemes with TLS
|
|
378
|
-
# For HTTP backends, use protocol
|
|
379
|
-
# to specify the protocol version.
|
|
320
|
+
# The address of the API backend. The scheme is used to determine the backend
|
|
321
|
+
# protocol and security. The following schemes are accepted: SCHEME PROTOCOL
|
|
322
|
+
# SECURITY http:// HTTP None https:// HTTP TLS grpc:// gRPC None grpcs:// gRPC
|
|
323
|
+
# TLS It is recommended to explicitly include a scheme. Leaving out the scheme
|
|
324
|
+
# may cause constrasting behaviors across platforms. If the port is unspecified,
|
|
325
|
+
# the default is: - 80 for schemes without TLS - 443 for schemes with TLS For
|
|
326
|
+
# HTTP backends, use protocol to specify the protocol version.
|
|
380
327
|
# Corresponds to the JSON property `address`
|
|
381
328
|
# @return [String]
|
|
382
329
|
attr_accessor :address
|
|
@@ -387,18 +334,18 @@ module Google
|
|
|
387
334
|
# @return [Float]
|
|
388
335
|
attr_accessor :deadline
|
|
389
336
|
|
|
390
|
-
# When disable_auth is true, a JWT ID token won't be generated and the
|
|
391
|
-
#
|
|
392
|
-
#
|
|
393
|
-
#
|
|
337
|
+
# When disable_auth is true, a JWT ID token won't be generated and the original "
|
|
338
|
+
# Authorization" HTTP header will be preserved. If the header is used to carry
|
|
339
|
+
# the original token and is expected by the backend, this field must be set to
|
|
340
|
+
# true to preserve the header.
|
|
394
341
|
# Corresponds to the JSON property `disableAuth`
|
|
395
342
|
# @return [Boolean]
|
|
396
343
|
attr_accessor :disable_auth
|
|
397
344
|
alias_method :disable_auth?, :disable_auth
|
|
398
345
|
|
|
399
|
-
# The JWT audience is used when generating a JWT ID token for the backend.
|
|
400
|
-
#
|
|
401
|
-
#
|
|
346
|
+
# The JWT audience is used when generating a JWT ID token for the backend. This
|
|
347
|
+
# ID token will be added in the HTTP "authorization" header, and sent to the
|
|
348
|
+
# backend.
|
|
402
349
|
# Corresponds to the JSON property `jwtAudience`
|
|
403
350
|
# @return [String]
|
|
404
351
|
attr_accessor :jwt_audience
|
|
@@ -409,8 +356,8 @@ module Google
|
|
|
409
356
|
# @return [Float]
|
|
410
357
|
attr_accessor :min_deadline
|
|
411
358
|
|
|
412
|
-
# The number of seconds to wait for the completion of a long running
|
|
413
|
-
#
|
|
359
|
+
# The number of seconds to wait for the completion of a long running operation.
|
|
360
|
+
# The default is no deadline.
|
|
414
361
|
# Corresponds to the JSON property `operationDeadline`
|
|
415
362
|
# @return [Float]
|
|
416
363
|
attr_accessor :operation_deadline
|
|
@@ -420,29 +367,21 @@ module Google
|
|
|
420
367
|
# @return [String]
|
|
421
368
|
attr_accessor :path_translation
|
|
422
369
|
|
|
423
|
-
# The protocol used for sending a request to the backend.
|
|
424
|
-
#
|
|
425
|
-
#
|
|
426
|
-
#
|
|
427
|
-
#
|
|
428
|
-
#
|
|
429
|
-
# https://
|
|
430
|
-
#
|
|
431
|
-
#
|
|
432
|
-
# For secure HTTP backends (https://) that support HTTP/2, set this field
|
|
433
|
-
# to "h2" for improved performance.
|
|
434
|
-
# Configuring this field to non-default values is only supported for secure
|
|
435
|
-
# HTTP backends. This field will be ignored for all other backends.
|
|
436
|
-
# See
|
|
437
|
-
# https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-
|
|
438
|
-
# values.xhtml#alpn-protocol-ids
|
|
439
|
-
# for more details on the supported values.
|
|
370
|
+
# The protocol used for sending a request to the backend. The supported values
|
|
371
|
+
# are "http/1.1" and "h2". The default value is inferred from the scheme in the
|
|
372
|
+
# address field: SCHEME PROTOCOL http:// http/1.1 https:// http/1.1 grpc:// h2
|
|
373
|
+
# grpcs:// h2 For secure HTTP backends (https://) that support HTTP/2, set this
|
|
374
|
+
# field to "h2" for improved performance. Configuring this field to non-default
|
|
375
|
+
# values is only supported for secure HTTP backends. This field will be ignored
|
|
376
|
+
# for all other backends. See https://www.iana.org/assignments/tls-extensiontype-
|
|
377
|
+
# values/tls-extensiontype-values.xhtml#alpn-protocol-ids for more details on
|
|
378
|
+
# the supported values.
|
|
440
379
|
# Corresponds to the JSON property `protocol`
|
|
441
380
|
# @return [String]
|
|
442
381
|
attr_accessor :protocol
|
|
443
382
|
|
|
444
|
-
# Selects the methods to which this rule applies.
|
|
445
|
-
#
|
|
383
|
+
# Selects the methods to which this rule applies. Refer to selector for syntax
|
|
384
|
+
# details.
|
|
446
385
|
# Corresponds to the JSON property `selector`
|
|
447
386
|
# @return [String]
|
|
448
387
|
attr_accessor :selector
|
|
@@ -465,42 +404,28 @@ module Google
|
|
|
465
404
|
end
|
|
466
405
|
end
|
|
467
406
|
|
|
468
|
-
# Billing related configuration of the service.
|
|
469
|
-
#
|
|
470
|
-
#
|
|
471
|
-
#
|
|
472
|
-
#
|
|
473
|
-
#
|
|
474
|
-
#
|
|
475
|
-
#
|
|
476
|
-
# -
|
|
477
|
-
#
|
|
478
|
-
# - key:
|
|
479
|
-
#
|
|
480
|
-
#
|
|
481
|
-
# -
|
|
482
|
-
#
|
|
483
|
-
# Custom label to define the city where the library branch is located
|
|
484
|
-
# in.
|
|
485
|
-
# - key: name
|
|
486
|
-
# description: Custom label to define the name of the library branch.
|
|
487
|
-
# metrics:
|
|
488
|
-
# - name: library.googleapis.com/book/borrowed_count
|
|
489
|
-
# metric_kind: DELTA
|
|
490
|
-
# value_type: INT64
|
|
491
|
-
# unit: "1"
|
|
492
|
-
# billing:
|
|
493
|
-
# consumer_destinations:
|
|
494
|
-
# - monitored_resource: library.googleapis.com/billing_branch
|
|
495
|
-
# metrics:
|
|
496
|
-
# - library.googleapis.com/book/borrowed_count
|
|
407
|
+
# Billing related configuration of the service. The following example shows how
|
|
408
|
+
# to configure monitored resources and metrics for billing, `
|
|
409
|
+
# consumer_destinations` is the only supported destination and the monitored
|
|
410
|
+
# resources need at least one label key `cloud.googleapis.com/location` to
|
|
411
|
+
# indicate the location of the billing usage, using different monitored
|
|
412
|
+
# resources between monitoring and billing is recommended so they can be evolved
|
|
413
|
+
# independently: monitored_resources: - type: library.googleapis.com/
|
|
414
|
+
# billing_branch labels: - key: cloud.googleapis.com/location description: |
|
|
415
|
+
# Predefined label to support billing location restriction. - key: city
|
|
416
|
+
# description: | Custom label to define the city where the library branch is
|
|
417
|
+
# located in. - key: name description: Custom label to define the name of the
|
|
418
|
+
# library branch. metrics: - name: library.googleapis.com/book/borrowed_count
|
|
419
|
+
# metric_kind: DELTA value_type: INT64 unit: "1" billing: consumer_destinations:
|
|
420
|
+
# - monitored_resource: library.googleapis.com/billing_branch metrics: - library.
|
|
421
|
+
# googleapis.com/book/borrowed_count
|
|
497
422
|
class Billing
|
|
498
423
|
include Google::Apis::Core::Hashable
|
|
499
424
|
|
|
500
|
-
# Billing configurations for sending metrics to the consumer project.
|
|
501
|
-
#
|
|
502
|
-
#
|
|
503
|
-
#
|
|
425
|
+
# Billing configurations for sending metrics to the consumer project. There can
|
|
426
|
+
# be multiple consumer destinations per service, each one must have a different
|
|
427
|
+
# monitored resource type. A metric can be used in at most one consumer
|
|
428
|
+
# destination.
|
|
504
429
|
# Corresponds to the JSON property `consumerDestinations`
|
|
505
430
|
# @return [Array<Google::Apis::ServiceconsumermanagementV1beta1::BillingDestination>]
|
|
506
431
|
attr_accessor :consumer_destinations
|
|
@@ -515,19 +440,19 @@ module Google
|
|
|
515
440
|
end
|
|
516
441
|
end
|
|
517
442
|
|
|
518
|
-
# Configuration of a specific billing destination (Currently only support
|
|
519
|
-
#
|
|
443
|
+
# Configuration of a specific billing destination (Currently only support bill
|
|
444
|
+
# against consumer project).
|
|
520
445
|
class BillingDestination
|
|
521
446
|
include Google::Apis::Core::Hashable
|
|
522
447
|
|
|
523
|
-
# Names of the metrics to report to this billing destination.
|
|
524
|
-
#
|
|
448
|
+
# Names of the metrics to report to this billing destination. Each name must be
|
|
449
|
+
# defined in Service.metrics section.
|
|
525
450
|
# Corresponds to the JSON property `metrics`
|
|
526
451
|
# @return [Array<String>]
|
|
527
452
|
attr_accessor :metrics
|
|
528
453
|
|
|
529
|
-
# The monitored resource type. The type must be defined in
|
|
530
|
-
#
|
|
454
|
+
# The monitored resource type. The type must be defined in Service.
|
|
455
|
+
# monitored_resources section.
|
|
531
456
|
# Corresponds to the JSON property `monitoredResource`
|
|
532
457
|
# @return [String]
|
|
533
458
|
attr_accessor :monitored_resource
|
|
@@ -543,39 +468,24 @@ module Google
|
|
|
543
468
|
end
|
|
544
469
|
end
|
|
545
470
|
|
|
546
|
-
# `Context` defines which contexts an API requests.
|
|
547
|
-
#
|
|
548
|
-
# context
|
|
549
|
-
#
|
|
550
|
-
#
|
|
551
|
-
#
|
|
552
|
-
# -
|
|
553
|
-
#
|
|
554
|
-
#
|
|
555
|
-
#
|
|
556
|
-
#
|
|
557
|
-
#
|
|
558
|
-
#
|
|
559
|
-
# This also provides mechanism to whitelist any protobuf message extension that
|
|
560
|
-
# can be sent in grpc metadata using “x-goog-ext-<extension_id>-bin” and
|
|
561
|
-
# “x-goog-ext-<extension_id>-jspb” format. For example, list any service
|
|
562
|
-
# specific protobuf types that can appear in grpc metadata as follows in your
|
|
563
|
-
# yaml file:
|
|
564
|
-
# Example:
|
|
565
|
-
# context:
|
|
566
|
-
# rules:
|
|
567
|
-
# - selector: "google.example.library.v1.LibraryService.CreateBook"
|
|
568
|
-
# allowed_request_extensions:
|
|
569
|
-
# - google.foo.v1.NewExtension
|
|
570
|
-
# allowed_response_extensions:
|
|
571
|
-
# - google.foo.v1.NewExtension
|
|
572
|
-
# You can also specify extension ID instead of fully qualified extension name
|
|
573
|
-
# here.
|
|
471
|
+
# `Context` defines which contexts an API requests. Example: context: rules: -
|
|
472
|
+
# selector: "*" requested: - google.rpc.context.ProjectContext - google.rpc.
|
|
473
|
+
# context.OriginContext The above specifies that all methods in the API request `
|
|
474
|
+
# google.rpc.context.ProjectContext` and `google.rpc.context.OriginContext`.
|
|
475
|
+
# Available context types are defined in package `google.rpc.context`. This also
|
|
476
|
+
# provides mechanism to whitelist any protobuf message extension that can be
|
|
477
|
+
# sent in grpc metadata using “x-goog-ext--bin” and “x-goog-ext--jspb” format.
|
|
478
|
+
# For example, list any service specific protobuf types that can appear in grpc
|
|
479
|
+
# metadata as follows in your yaml file: Example: context: rules: - selector: "
|
|
480
|
+
# google.example.library.v1.LibraryService.CreateBook"
|
|
481
|
+
# allowed_request_extensions: - google.foo.v1.NewExtension
|
|
482
|
+
# allowed_response_extensions: - google.foo.v1.NewExtension You can also specify
|
|
483
|
+
# extension ID instead of fully qualified extension name here.
|
|
574
484
|
class Context
|
|
575
485
|
include Google::Apis::Core::Hashable
|
|
576
486
|
|
|
577
|
-
# A list of RPC context rules that apply to individual API methods.
|
|
578
|
-
#
|
|
487
|
+
# A list of RPC context rules that apply to individual API methods. **NOTE:**
|
|
488
|
+
# All service configuration rules follow "last one wins" order.
|
|
579
489
|
# Corresponds to the JSON property `rules`
|
|
580
490
|
# @return [Array<Google::Apis::ServiceconsumermanagementV1beta1::ContextRule>]
|
|
581
491
|
attr_accessor :rules
|
|
@@ -595,14 +505,14 @@ module Google
|
|
|
595
505
|
class ContextRule
|
|
596
506
|
include Google::Apis::Core::Hashable
|
|
597
507
|
|
|
598
|
-
# A list of full type names or extension IDs of extensions allowed in grpc
|
|
599
|
-
#
|
|
508
|
+
# A list of full type names or extension IDs of extensions allowed in grpc side
|
|
509
|
+
# channel from client to backend.
|
|
600
510
|
# Corresponds to the JSON property `allowedRequestExtensions`
|
|
601
511
|
# @return [Array<String>]
|
|
602
512
|
attr_accessor :allowed_request_extensions
|
|
603
513
|
|
|
604
|
-
# A list of full type names or extension IDs of extensions allowed in grpc
|
|
605
|
-
#
|
|
514
|
+
# A list of full type names or extension IDs of extensions allowed in grpc side
|
|
515
|
+
# channel from backend to client.
|
|
606
516
|
# Corresponds to the JSON property `allowedResponseExtensions`
|
|
607
517
|
# @return [Array<String>]
|
|
608
518
|
attr_accessor :allowed_response_extensions
|
|
@@ -617,8 +527,8 @@ module Google
|
|
|
617
527
|
# @return [Array<String>]
|
|
618
528
|
attr_accessor :requested
|
|
619
529
|
|
|
620
|
-
# Selects the methods to which this rule applies.
|
|
621
|
-
#
|
|
530
|
+
# Selects the methods to which this rule applies. Refer to selector for syntax
|
|
531
|
+
# details.
|
|
622
532
|
# Corresponds to the JSON property `selector`
|
|
623
533
|
# @return [String]
|
|
624
534
|
attr_accessor :selector
|
|
@@ -637,14 +547,14 @@ module Google
|
|
|
637
547
|
end
|
|
638
548
|
end
|
|
639
549
|
|
|
640
|
-
# Selects and configures the service controller used by the service.
|
|
641
|
-
#
|
|
642
|
-
#
|
|
550
|
+
# Selects and configures the service controller used by the service. The service
|
|
551
|
+
# controller handles features like abuse, quota, billing, logging, monitoring,
|
|
552
|
+
# etc.
|
|
643
553
|
class Control
|
|
644
554
|
include Google::Apis::Core::Hashable
|
|
645
555
|
|
|
646
|
-
# The service control environment to use. If empty, no control plane
|
|
647
|
-
#
|
|
556
|
+
# The service control environment to use. If empty, no control plane feature (
|
|
557
|
+
# like quota and billing) will be enabled.
|
|
648
558
|
# Corresponds to the JSON property `environment`
|
|
649
559
|
# @return [String]
|
|
650
560
|
attr_accessor :environment
|
|
@@ -659,19 +569,15 @@ module Google
|
|
|
659
569
|
end
|
|
660
570
|
end
|
|
661
571
|
|
|
662
|
-
# Customize service error responses.
|
|
663
|
-
#
|
|
664
|
-
#
|
|
665
|
-
#
|
|
666
|
-
# custom_error:
|
|
667
|
-
# types:
|
|
668
|
-
# - google.foo.v1.CustomError
|
|
669
|
-
# - google.foo.v1.AnotherError
|
|
572
|
+
# Customize service error responses. For example, list any service specific
|
|
573
|
+
# protobuf types that can appear in error detail lists of error responses.
|
|
574
|
+
# Example: custom_error: types: - google.foo.v1.CustomError - google.foo.v1.
|
|
575
|
+
# AnotherError
|
|
670
576
|
class CustomError
|
|
671
577
|
include Google::Apis::Core::Hashable
|
|
672
578
|
|
|
673
|
-
# The list of custom error rules that apply to individual API messages.
|
|
674
|
-
#
|
|
579
|
+
# The list of custom error rules that apply to individual API messages. **NOTE:**
|
|
580
|
+
# All service configuration rules follow "last one wins" order.
|
|
675
581
|
# Corresponds to the JSON property `rules`
|
|
676
582
|
# @return [Array<Google::Apis::ServiceconsumermanagementV1beta1::CustomErrorRule>]
|
|
677
583
|
attr_accessor :rules
|
|
@@ -696,15 +602,15 @@ module Google
|
|
|
696
602
|
class CustomErrorRule
|
|
697
603
|
include Google::Apis::Core::Hashable
|
|
698
604
|
|
|
699
|
-
# Mark this message as possible payload in error response.
|
|
700
|
-
#
|
|
605
|
+
# Mark this message as possible payload in error response. Otherwise, objects of
|
|
606
|
+
# this type will be filtered when they appear in error payload.
|
|
701
607
|
# Corresponds to the JSON property `isErrorType`
|
|
702
608
|
# @return [Boolean]
|
|
703
609
|
attr_accessor :is_error_type
|
|
704
610
|
alias_method :is_error_type?, :is_error_type
|
|
705
611
|
|
|
706
|
-
# Selects messages to which this rule applies.
|
|
707
|
-
#
|
|
612
|
+
# Selects messages to which this rule applies. Refer to selector for syntax
|
|
613
|
+
# details.
|
|
708
614
|
# Corresponds to the JSON property `selector`
|
|
709
615
|
# @return [String]
|
|
710
616
|
attr_accessor :selector
|
|
@@ -745,56 +651,32 @@ module Google
|
|
|
745
651
|
end
|
|
746
652
|
end
|
|
747
653
|
|
|
748
|
-
# `Documentation` provides the information for describing a service.
|
|
749
|
-
#
|
|
750
|
-
#
|
|
751
|
-
#
|
|
752
|
-
#
|
|
753
|
-
#
|
|
754
|
-
#
|
|
755
|
-
#
|
|
756
|
-
#
|
|
757
|
-
#
|
|
758
|
-
#
|
|
759
|
-
#
|
|
760
|
-
#
|
|
761
|
-
#
|
|
762
|
-
#
|
|
763
|
-
#
|
|
764
|
-
#
|
|
765
|
-
#
|
|
766
|
-
#
|
|
767
|
-
#
|
|
768
|
-
#
|
|
769
|
-
#
|
|
770
|
-
#
|
|
771
|
-
#
|
|
772
|
-
#
|
|
773
|
-
#
|
|
774
|
-
# a documentation fragment is embedded.
|
|
775
|
-
# Documentation from the IDL is merged with documentation defined
|
|
776
|
-
# via the config at normalization time, where documentation provided
|
|
777
|
-
# by config rules overrides IDL provided.
|
|
778
|
-
# A number of constructs specific to the API platform are supported
|
|
779
|
-
# in documentation text.
|
|
780
|
-
# In order to reference a proto element, the following
|
|
781
|
-
# notation can be used:
|
|
782
|
-
# <pre><code>[fully.qualified.proto.name][]</code></pre>
|
|
783
|
-
# To override the display text used for the link, this can be used:
|
|
784
|
-
# <pre><code>[display text][fully.qualified.proto.name]</code></pre>
|
|
785
|
-
# Text can be excluded from doc using the following notation:
|
|
786
|
-
# <pre><code>(-- internal comment --)</code></pre>
|
|
787
|
-
# A few directives are available in documentation. Note that
|
|
788
|
-
# directives must appear on a single line to be properly
|
|
789
|
-
# identified. The `include` directive includes a markdown file from
|
|
790
|
-
# an external source:
|
|
791
|
-
# <pre><code>(== include path/to/file ==)</code></pre>
|
|
792
|
-
# The `resource_for` directive marks a message to be the resource of
|
|
793
|
-
# a collection in REST view. If it is not specified, tools attempt
|
|
794
|
-
# to infer the resource from the operations in a collection:
|
|
795
|
-
# <pre><code>(== resource_for v1.shelves.books ==)</code></pre>
|
|
796
|
-
# The directive `suppress_warning` does not directly affect documentation
|
|
797
|
-
# and is documented together with service config validation.
|
|
654
|
+
# `Documentation` provides the information for describing a service. Example:
|
|
655
|
+
# documentation: summary: > The Google Calendar API gives access to most
|
|
656
|
+
# calendar features. pages: - name: Overview content: (== include google/foo/
|
|
657
|
+
# overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==
|
|
658
|
+
# ) subpages; - name: Java content: (== include google/foo/tutorial_java.md ==)
|
|
659
|
+
# rules: - selector: google.calendar.Calendar.Get description: > ... - selector:
|
|
660
|
+
# google.calendar.Calendar.Put description: > ... Documentation is provided in
|
|
661
|
+
# markdown syntax. In addition to standard markdown features, definition lists,
|
|
662
|
+
# tables and fenced code blocks are supported. Section headers can be provided
|
|
663
|
+
# and are interpreted relative to the section nesting of the context where a
|
|
664
|
+
# documentation fragment is embedded. Documentation from the IDL is merged with
|
|
665
|
+
# documentation defined via the config at normalization time, where
|
|
666
|
+
# documentation provided by config rules overrides IDL provided. A number of
|
|
667
|
+
# constructs specific to the API platform are supported in documentation text.
|
|
668
|
+
# In order to reference a proto element, the following notation can be used: [
|
|
669
|
+
# fully.qualified.proto.name][] To override the display text used for the link,
|
|
670
|
+
# this can be used: [display text][fully.qualified.proto.name] Text can be
|
|
671
|
+
# excluded from doc using the following notation: (-- internal comment --) A few
|
|
672
|
+
# directives are available in documentation. Note that directives must appear on
|
|
673
|
+
# a single line to be properly identified. The `include` directive includes a
|
|
674
|
+
# markdown file from an external source: (== include path/to/file ==) The `
|
|
675
|
+
# resource_for` directive marks a message to be the resource of a collection in
|
|
676
|
+
# REST view. If it is not specified, tools attempt to infer the resource from
|
|
677
|
+
# the operations in a collection: (== resource_for v1.shelves.books ==) The
|
|
678
|
+
# directive `suppress_warning` does not directly affect documentation and is
|
|
679
|
+
# documented together with service config validation.
|
|
798
680
|
class Documentation
|
|
799
681
|
include Google::Apis::Core::Hashable
|
|
800
682
|
|
|
@@ -803,19 +685,11 @@ module Google
|
|
|
803
685
|
# @return [String]
|
|
804
686
|
attr_accessor :documentation_root_url
|
|
805
687
|
|
|
806
|
-
# Declares a single overview page. For example:
|
|
807
|
-
#
|
|
808
|
-
# summary: ...
|
|
809
|
-
#
|
|
810
|
-
#
|
|
811
|
-
# This is a shortcut for the following declaration (using pages style):
|
|
812
|
-
# <pre><code>documentation:
|
|
813
|
-
# summary: ...
|
|
814
|
-
# pages:
|
|
815
|
-
# - name: Overview
|
|
816
|
-
# content: (== include overview.md ==)
|
|
817
|
-
# </code></pre>
|
|
818
|
-
# Note: you cannot specify both `overview` field and `pages` field.
|
|
688
|
+
# Declares a single overview page. For example: documentation: summary: ...
|
|
689
|
+
# overview: (== include overview.md ==) This is a shortcut for the following
|
|
690
|
+
# declaration (using pages style): documentation: summary: ... pages: - name:
|
|
691
|
+
# Overview content: (== include overview.md ==) Note: you cannot specify both `
|
|
692
|
+
# overview` field and `pages` field.
|
|
819
693
|
# Corresponds to the JSON property `overview`
|
|
820
694
|
# @return [String]
|
|
821
695
|
attr_accessor :overview
|
|
@@ -825,22 +699,20 @@ module Google
|
|
|
825
699
|
# @return [Array<Google::Apis::ServiceconsumermanagementV1beta1::Page>]
|
|
826
700
|
attr_accessor :pages
|
|
827
701
|
|
|
828
|
-
# A list of documentation rules that apply to individual API elements.
|
|
829
|
-
#
|
|
702
|
+
# A list of documentation rules that apply to individual API elements. **NOTE:**
|
|
703
|
+
# All service configuration rules follow "last one wins" order.
|
|
830
704
|
# Corresponds to the JSON property `rules`
|
|
831
705
|
# @return [Array<Google::Apis::ServiceconsumermanagementV1beta1::DocumentationRule>]
|
|
832
706
|
attr_accessor :rules
|
|
833
707
|
|
|
834
|
-
# Specifies the service root url if the default one (the service name
|
|
835
|
-
#
|
|
836
|
-
#
|
|
837
|
-
# urls are relative to.
|
|
708
|
+
# Specifies the service root url if the default one (the service name from the
|
|
709
|
+
# yaml file) is not suitable. This can be seen in any fully specified service
|
|
710
|
+
# urls as well as sections that show a base that other urls are relative to.
|
|
838
711
|
# Corresponds to the JSON property `serviceRootUrl`
|
|
839
712
|
# @return [String]
|
|
840
713
|
attr_accessor :service_root_url
|
|
841
714
|
|
|
842
|
-
# A short summary of what the service does. Can only be provided by
|
|
843
|
-
# plain text.
|
|
715
|
+
# A short summary of what the service does. Can only be provided by plain text.
|
|
844
716
|
# Corresponds to the JSON property `summary`
|
|
845
717
|
# @return [String]
|
|
846
718
|
attr_accessor :summary
|
|
@@ -864,8 +736,8 @@ module Google
|
|
|
864
736
|
class DocumentationRule
|
|
865
737
|
include Google::Apis::Core::Hashable
|
|
866
738
|
|
|
867
|
-
# Deprecation description of the selected element(s). It can be provided if
|
|
868
|
-
#
|
|
739
|
+
# Deprecation description of the selected element(s). It can be provided if an
|
|
740
|
+
# element is marked as `deprecated`.
|
|
869
741
|
# Corresponds to the JSON property `deprecationDescription`
|
|
870
742
|
# @return [String]
|
|
871
743
|
attr_accessor :deprecation_description
|
|
@@ -897,13 +769,11 @@ module Google
|
|
|
897
769
|
end
|
|
898
770
|
end
|
|
899
771
|
|
|
900
|
-
# A generic empty message that you can re-use to avoid defining duplicated
|
|
901
|
-
#
|
|
902
|
-
#
|
|
903
|
-
#
|
|
904
|
-
#
|
|
905
|
-
# `
|
|
906
|
-
# The JSON representation for `Empty` is empty JSON object ````.
|
|
772
|
+
# A generic empty message that you can re-use to avoid defining duplicated empty
|
|
773
|
+
# messages in your APIs. A typical example is to use it as the request or the
|
|
774
|
+
# response type of an API method. For instance: service Foo ` rpc Bar(google.
|
|
775
|
+
# protobuf.Empty) returns (google.protobuf.Empty); ` The JSON representation for
|
|
776
|
+
# `Empty` is empty JSON object ````.
|
|
907
777
|
class Empty
|
|
908
778
|
include Google::Apis::Core::Hashable
|
|
909
779
|
|
|
@@ -916,35 +786,28 @@ module Google
|
|
|
916
786
|
end
|
|
917
787
|
end
|
|
918
788
|
|
|
919
|
-
# `Endpoint` describes a network endpoint that serves a set of APIs.
|
|
920
|
-
#
|
|
921
|
-
#
|
|
922
|
-
# configuration.
|
|
923
|
-
#
|
|
924
|
-
#
|
|
925
|
-
#
|
|
926
|
-
# #
|
|
927
|
-
#
|
|
928
|
-
# # It also allows HTTP OPTIONS calls to be passed to the backend, for
|
|
929
|
-
# # it to decide whether the subsequent cross-origin request is
|
|
930
|
-
# # allowed to proceed.
|
|
931
|
-
# - name: library-example.googleapis.com
|
|
932
|
-
# allow_cors: true
|
|
789
|
+
# `Endpoint` describes a network endpoint that serves a set of APIs. A service
|
|
790
|
+
# may expose any number of endpoints, and all endpoints share the same service
|
|
791
|
+
# configuration, such as quota configuration and monitoring configuration.
|
|
792
|
+
# Example service configuration: name: library-example.googleapis.com endpoints:
|
|
793
|
+
# # Below entry makes 'google.example.library.v1.Library' # API be served from
|
|
794
|
+
# endpoint address library-example.googleapis.com. # It also allows HTTP OPTIONS
|
|
795
|
+
# calls to be passed to the backend, for # it to decide whether the subsequent
|
|
796
|
+
# cross-origin request is # allowed to proceed. - name: library-example.
|
|
797
|
+
# googleapis.com allow_cors: true
|
|
933
798
|
class Endpoint
|
|
934
799
|
include Google::Apis::Core::Hashable
|
|
935
800
|
|
|
936
801
|
# DEPRECATED: This field is no longer supported. Instead of using aliases,
|
|
937
|
-
# please specify multiple google.api.Endpoint for each of the intended
|
|
938
|
-
# aliases.
|
|
802
|
+
# please specify multiple google.api.Endpoint for each of the intended aliases.
|
|
939
803
|
# Additional names that this endpoint will be hosted on.
|
|
940
804
|
# Corresponds to the JSON property `aliases`
|
|
941
805
|
# @return [Array<String>]
|
|
942
806
|
attr_accessor :aliases
|
|
943
807
|
|
|
944
|
-
# Allowing
|
|
945
|
-
#
|
|
946
|
-
#
|
|
947
|
-
# receive and respond to HTTP OPTIONS requests. The response will be used by
|
|
808
|
+
# Allowing [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing),
|
|
809
|
+
# aka cross-domain traffic, would allow the backends served from this endpoint
|
|
810
|
+
# to receive and respond to HTTP OPTIONS requests. The response will be used by
|
|
948
811
|
# the browser to determine whether the subsequent cross-origin request is
|
|
949
812
|
# allowed to proceed.
|
|
950
813
|
# Corresponds to the JSON property `allowCors`
|
|
@@ -958,10 +821,9 @@ module Google
|
|
|
958
821
|
attr_accessor :name
|
|
959
822
|
|
|
960
823
|
# The specification of an Internet routable address of API frontend that will
|
|
961
|
-
# handle requests to this [API
|
|
962
|
-
#
|
|
963
|
-
#
|
|
964
|
-
# "8.8.8.8" or "myservice.appspot.com".
|
|
824
|
+
# handle requests to this [API Endpoint](https://cloud.google.com/apis/design/
|
|
825
|
+
# glossary). It should be either a valid IPv4 address or a fully-qualified
|
|
826
|
+
# domain name. For example, "8.8.8.8" or "myservice.appspot.com".
|
|
965
827
|
# Corresponds to the JSON property `target`
|
|
966
828
|
# @return [String]
|
|
967
829
|
attr_accessor :target
|
|
@@ -998,8 +860,8 @@ module Google
|
|
|
998
860
|
# @return [Array<Google::Apis::ServiceconsumermanagementV1beta1::Option>]
|
|
999
861
|
attr_accessor :options
|
|
1000
862
|
|
|
1001
|
-
# `SourceContext` represents information about the source of a
|
|
1002
|
-
#
|
|
863
|
+
# `SourceContext` represents information about the source of a protobuf element,
|
|
864
|
+
# like the file in which it is defined.
|
|
1003
865
|
# Corresponds to the JSON property `sourceContext`
|
|
1004
866
|
# @return [Google::Apis::ServiceconsumermanagementV1beta1::SourceContext]
|
|
1005
867
|
attr_accessor :source_context
|
|
@@ -1088,8 +950,8 @@ module Google
|
|
|
1088
950
|
# @return [Fixnum]
|
|
1089
951
|
attr_accessor :number
|
|
1090
952
|
|
|
1091
|
-
# The index of the field type in `Type.oneofs`, for message or enumeration
|
|
1092
|
-
#
|
|
953
|
+
# The index of the field type in `Type.oneofs`, for message or enumeration types.
|
|
954
|
+
# The first type has index 1; zero means the type is not in the list.
|
|
1093
955
|
# Corresponds to the JSON property `oneofIndex`
|
|
1094
956
|
# @return [Fixnum]
|
|
1095
957
|
attr_accessor :oneof_index
|
|
@@ -1105,8 +967,8 @@ module Google
|
|
|
1105
967
|
attr_accessor :packed
|
|
1106
968
|
alias_method :packed?, :packed
|
|
1107
969
|
|
|
1108
|
-
# The field type URL, without the scheme, for message or enumeration
|
|
1109
|
-
#
|
|
970
|
+
# The field type URL, without the scheme, for message or enumeration types.
|
|
971
|
+
# Example: `"type.googleapis.com/google.protobuf.Timestamp"`.
|
|
1110
972
|
# Corresponds to the JSON property `typeUrl`
|
|
1111
973
|
# @return [String]
|
|
1112
974
|
attr_accessor :type_url
|
|
@@ -1131,23 +993,22 @@ module Google
|
|
|
1131
993
|
end
|
|
1132
994
|
|
|
1133
995
|
# Defines the HTTP configuration for an API service. It contains a list of
|
|
1134
|
-
# HttpRule, each specifying the mapping of an RPC method
|
|
1135
|
-
#
|
|
996
|
+
# HttpRule, each specifying the mapping of an RPC method to one or more HTTP
|
|
997
|
+
# REST API methods.
|
|
1136
998
|
class Http
|
|
1137
999
|
include Google::Apis::Core::Hashable
|
|
1138
1000
|
|
|
1139
1001
|
# When set to true, URL path parameters will be fully URI-decoded except in
|
|
1140
1002
|
# cases of single segment matches in reserved expansion, where "%2F" will be
|
|
1141
|
-
# left encoded.
|
|
1142
|
-
#
|
|
1143
|
-
# segment matches.
|
|
1003
|
+
# left encoded. The default behavior is to not decode RFC 6570 reserved
|
|
1004
|
+
# characters in multi segment matches.
|
|
1144
1005
|
# Corresponds to the JSON property `fullyDecodeReservedExpansion`
|
|
1145
1006
|
# @return [Boolean]
|
|
1146
1007
|
attr_accessor :fully_decode_reserved_expansion
|
|
1147
1008
|
alias_method :fully_decode_reserved_expansion?, :fully_decode_reserved_expansion
|
|
1148
1009
|
|
|
1149
|
-
# A list of HTTP configuration rules that apply to individual API methods.
|
|
1150
|
-
#
|
|
1010
|
+
# A list of HTTP configuration rules that apply to individual API methods. **
|
|
1011
|
+
# NOTE:** All service configuration rules follow "last one wins" order.
|
|
1151
1012
|
# Corresponds to the JSON property `rules`
|
|
1152
1013
|
# @return [Array<Google::Apis::ServiceconsumermanagementV1beta1::HttpRule>]
|
|
1153
1014
|
attr_accessor :rules
|
|
@@ -1163,251 +1024,156 @@ module Google
|
|
|
1163
1024
|
end
|
|
1164
1025
|
end
|
|
1165
1026
|
|
|
1166
|
-
# # gRPC Transcoding
|
|
1167
|
-
#
|
|
1168
|
-
#
|
|
1169
|
-
#
|
|
1170
|
-
#
|
|
1171
|
-
# [
|
|
1172
|
-
#
|
|
1173
|
-
#
|
|
1174
|
-
#
|
|
1175
|
-
#
|
|
1176
|
-
#
|
|
1177
|
-
# path, URL query parameters, and HTTP request body. It also controls how the
|
|
1178
|
-
# gRPC response message is mapped to the HTTP response body. `HttpRule` is
|
|
1027
|
+
# # gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC
|
|
1028
|
+
# method and one or more HTTP REST endpoints. It allows developers to build a
|
|
1029
|
+
# single API service that supports both gRPC APIs and REST APIs. Many systems,
|
|
1030
|
+
# including [Google APIs](https://github.com/googleapis/googleapis), [Cloud
|
|
1031
|
+
# Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.
|
|
1032
|
+
# com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/
|
|
1033
|
+
# envoy) proxy support this feature and use it for large scale production
|
|
1034
|
+
# services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping
|
|
1035
|
+
# specifies how different portions of the gRPC request message are mapped to the
|
|
1036
|
+
# URL path, URL query parameters, and HTTP request body. It also controls how
|
|
1037
|
+
# the gRPC response message is mapped to the HTTP response body. `HttpRule` is
|
|
1179
1038
|
# typically specified as an `google.api.http` annotation on the gRPC method.
|
|
1180
1039
|
# Each mapping specifies a URL path template and an HTTP method. The path
|
|
1181
1040
|
# template may refer to one or more fields in the gRPC request message, as long
|
|
1182
|
-
# as each field is a non-repeated field with a primitive (non-message) type.
|
|
1183
|
-
#
|
|
1184
|
-
#
|
|
1185
|
-
#
|
|
1186
|
-
#
|
|
1187
|
-
#
|
|
1188
|
-
#
|
|
1189
|
-
#
|
|
1190
|
-
#
|
|
1191
|
-
#
|
|
1192
|
-
# `
|
|
1193
|
-
#
|
|
1194
|
-
# string
|
|
1195
|
-
#
|
|
1196
|
-
#
|
|
1197
|
-
#
|
|
1198
|
-
# `
|
|
1199
|
-
#
|
|
1200
|
-
#
|
|
1201
|
-
#
|
|
1202
|
-
#
|
|
1203
|
-
#
|
|
1204
|
-
#
|
|
1205
|
-
#
|
|
1206
|
-
#
|
|
1207
|
-
# rpc
|
|
1208
|
-
#
|
|
1209
|
-
#
|
|
1210
|
-
#
|
|
1211
|
-
#
|
|
1212
|
-
# `
|
|
1213
|
-
#
|
|
1214
|
-
# message
|
|
1215
|
-
#
|
|
1216
|
-
#
|
|
1217
|
-
#
|
|
1218
|
-
#
|
|
1219
|
-
#
|
|
1220
|
-
# `
|
|
1221
|
-
#
|
|
1222
|
-
#
|
|
1223
|
-
#
|
|
1224
|
-
#
|
|
1225
|
-
#
|
|
1226
|
-
#
|
|
1227
|
-
#
|
|
1228
|
-
#
|
|
1229
|
-
#
|
|
1230
|
-
#
|
|
1231
|
-
#
|
|
1232
|
-
#
|
|
1233
|
-
#
|
|
1234
|
-
#
|
|
1235
|
-
#
|
|
1236
|
-
#
|
|
1237
|
-
#
|
|
1238
|
-
#
|
|
1239
|
-
#
|
|
1240
|
-
#
|
|
1241
|
-
#
|
|
1242
|
-
#
|
|
1243
|
-
#
|
|
1244
|
-
#
|
|
1245
|
-
#
|
|
1246
|
-
#
|
|
1247
|
-
# `
|
|
1248
|
-
# The
|
|
1249
|
-
#
|
|
1250
|
-
#
|
|
1251
|
-
#
|
|
1252
|
-
#
|
|
1253
|
-
#
|
|
1254
|
-
#
|
|
1255
|
-
#
|
|
1256
|
-
#
|
|
1257
|
-
#
|
|
1258
|
-
# the
|
|
1259
|
-
#
|
|
1260
|
-
#
|
|
1261
|
-
#
|
|
1262
|
-
#
|
|
1263
|
-
#
|
|
1264
|
-
#
|
|
1265
|
-
#
|
|
1266
|
-
#
|
|
1267
|
-
#
|
|
1268
|
-
#
|
|
1269
|
-
#
|
|
1270
|
-
# `
|
|
1271
|
-
# The following HTTP JSON to RPC mapping is enabled:
|
|
1272
|
-
# HTTP | gRPC
|
|
1273
|
-
# -----|-----
|
|
1274
|
-
# `PATCH /v1/messages/123456 ` "text": "Hi!" `` | `UpdateMessage(message_id:
|
|
1275
|
-
# "123456" text: "Hi!")`
|
|
1276
|
-
# Note that when using `*` in the body mapping, it is not possible to
|
|
1277
|
-
# have HTTP parameters, as all fields not bound by the path end in
|
|
1278
|
-
# the body. This makes this option more rarely used in practice when
|
|
1279
|
-
# defining REST APIs. The common usage of `*` is in custom methods
|
|
1280
|
-
# which don't use the URL at all for transferring data.
|
|
1281
|
-
# It is possible to define multiple HTTP methods for one RPC by using
|
|
1282
|
-
# the `additional_bindings` option. Example:
|
|
1283
|
-
# service Messaging `
|
|
1284
|
-
# rpc GetMessage(GetMessageRequest) returns (Message) `
|
|
1285
|
-
# option (google.api.http) = `
|
|
1286
|
-
# get: "/v1/messages/`message_id`"
|
|
1287
|
-
# additional_bindings `
|
|
1288
|
-
# get: "/v1/users/`user_id`/messages/`message_id`"
|
|
1289
|
-
# `
|
|
1290
|
-
# `;
|
|
1291
|
-
# `
|
|
1292
|
-
# `
|
|
1293
|
-
# message GetMessageRequest `
|
|
1294
|
-
# string message_id = 1;
|
|
1295
|
-
# string user_id = 2;
|
|
1296
|
-
# `
|
|
1297
|
-
# This enables the following two alternative HTTP JSON to RPC mappings:
|
|
1298
|
-
# HTTP | gRPC
|
|
1299
|
-
# -----|-----
|
|
1300
|
-
# `GET /v1/messages/123456` | `GetMessage(message_id: "123456")`
|
|
1301
|
-
# `GET /v1/users/me/messages/123456` | `GetMessage(user_id: "me" message_id:
|
|
1302
|
-
# "123456")`
|
|
1303
|
-
# ## Rules for HTTP mapping
|
|
1304
|
-
# 1. Leaf request fields (recursive expansion nested messages in the request
|
|
1305
|
-
# message) are classified into three categories:
|
|
1306
|
-
# - Fields referred by the path template. They are passed via the URL path.
|
|
1307
|
-
# - Fields referred by the HttpRule.body. They are passed via the HTTP
|
|
1308
|
-
# request body.
|
|
1309
|
-
# - All other fields are passed via the URL query parameters, and the
|
|
1310
|
-
# parameter name is the field path in the request message. A repeated
|
|
1311
|
-
# field can be represented as multiple query parameters under the same
|
|
1312
|
-
# name.
|
|
1313
|
-
# 2. If HttpRule.body is "*", there is no URL query parameter, all fields
|
|
1314
|
-
# are passed via URL path and HTTP request body.
|
|
1315
|
-
# 3. If HttpRule.body is omitted, there is no HTTP request body, all
|
|
1316
|
-
# fields are passed via URL path and URL query parameters.
|
|
1317
|
-
# ### Path template syntax
|
|
1318
|
-
# Template = "/" Segments [ Verb ] ;
|
|
1319
|
-
# Segments = Segment ` "/" Segment ` ;
|
|
1320
|
-
# Segment = "*" | "**" | LITERAL | Variable ;
|
|
1321
|
-
# Variable = "`" FieldPath [ "=" Segments ] "`" ;
|
|
1322
|
-
# FieldPath = IDENT ` "." IDENT ` ;
|
|
1323
|
-
# Verb = ":" LITERAL ;
|
|
1324
|
-
# The syntax `*` matches a single URL path segment. The syntax `**` matches
|
|
1325
|
-
# zero or more URL path segments, which must be the last part of the URL path
|
|
1326
|
-
# except the `Verb`.
|
|
1327
|
-
# The syntax `Variable` matches part of the URL path as specified by its
|
|
1328
|
-
# template. A variable template must not contain other variables. If a variable
|
|
1329
|
-
# matches a single path segment, its template may be omitted, e.g. ``var``
|
|
1330
|
-
# is equivalent to ``var=*``.
|
|
1331
|
-
# The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL`
|
|
1332
|
-
# contains any reserved character, such characters should be percent-encoded
|
|
1333
|
-
# before the matching.
|
|
1334
|
-
# If a variable contains exactly one path segment, such as `"`var`"` or
|
|
1335
|
-
# `"`var=*`"`, when such a variable is expanded into a URL path on the client
|
|
1336
|
-
# side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The
|
|
1337
|
-
# server side does the reverse decoding. Such variables show up in the
|
|
1338
|
-
# [Discovery
|
|
1339
|
-
# Document](https://developers.google.com/discovery/v1/reference/apis) as
|
|
1340
|
-
# ``var``.
|
|
1341
|
-
# If a variable contains multiple path segments, such as `"`var=foo/*`"`
|
|
1342
|
-
# or `"`var=**`"`, when such a variable is expanded into a URL path on the
|
|
1343
|
-
# client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded.
|
|
1344
|
-
# The server side does the reverse decoding, except "%2F" and "%2f" are left
|
|
1345
|
-
# unchanged. Such variables show up in the
|
|
1346
|
-
# [Discovery
|
|
1347
|
-
# Document](https://developers.google.com/discovery/v1/reference/apis) as
|
|
1348
|
-
# ``+var``.
|
|
1349
|
-
# ## Using gRPC API Service Configuration
|
|
1350
|
-
# gRPC API Service Configuration (service config) is a configuration language
|
|
1351
|
-
# for configuring a gRPC service to become a user-facing product. The
|
|
1352
|
-
# service config is simply the YAML representation of the `google.api.Service`
|
|
1353
|
-
# proto message.
|
|
1041
|
+
# as each field is a non-repeated field with a primitive (non-message) type. The
|
|
1042
|
+
# path template controls how fields of the request message are mapped to the URL
|
|
1043
|
+
# path. Example: service Messaging ` rpc GetMessage(GetMessageRequest) returns (
|
|
1044
|
+
# Message) ` option (google.api.http) = ` get: "/v1/`name=messages/*`" `; ` `
|
|
1045
|
+
# message GetMessageRequest ` string name = 1; // Mapped to URL path. ` message
|
|
1046
|
+
# Message ` string text = 1; // The resource content. ` This enables an HTTP
|
|
1047
|
+
# REST to gRPC mapping as below: HTTP | gRPC -----|----- `GET /v1/messages/
|
|
1048
|
+
# 123456` | `GetMessage(name: "messages/123456")` Any fields in the request
|
|
1049
|
+
# message which are not bound by the path template automatically become HTTP
|
|
1050
|
+
# query parameters if there is no HTTP request body. For example: service
|
|
1051
|
+
# Messaging ` rpc GetMessage(GetMessageRequest) returns (Message) ` option (
|
|
1052
|
+
# google.api.http) = ` get:"/v1/messages/`message_id`" `; ` ` message
|
|
1053
|
+
# GetMessageRequest ` message SubMessage ` string subfield = 1; ` string
|
|
1054
|
+
# message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL
|
|
1055
|
+
# query parameter `revision`. SubMessage sub = 3; // Mapped to URL query
|
|
1056
|
+
# parameter `sub.subfield`. ` This enables a HTTP JSON to RPC mapping as below:
|
|
1057
|
+
# HTTP | gRPC -----|----- `GET /v1/messages/123456?revision=2&sub.subfield=foo` |
|
|
1058
|
+
# `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: "foo"))
|
|
1059
|
+
# ` Note that fields which are mapped to URL query parameters must have a
|
|
1060
|
+
# primitive type or a repeated primitive type or a non-repeated message type. In
|
|
1061
|
+
# the case of a repeated type, the parameter can be repeated in the URL as `...?
|
|
1062
|
+
# param=A¶m=B`. In the case of a message type, each field of the message is
|
|
1063
|
+
# mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For
|
|
1064
|
+
# HTTP methods that allow a request body, the `body` field specifies the mapping.
|
|
1065
|
+
# Consider a REST update method on the message resource collection: service
|
|
1066
|
+
# Messaging ` rpc UpdateMessage(UpdateMessageRequest) returns (Message) ` option
|
|
1067
|
+
# (google.api.http) = ` patch: "/v1/messages/`message_id`" body: "message" `; ` `
|
|
1068
|
+
# message UpdateMessageRequest ` string message_id = 1; // mapped to the URL
|
|
1069
|
+
# Message message = 2; // mapped to the body ` The following HTTP JSON to RPC
|
|
1070
|
+
# mapping is enabled, where the representation of the JSON in the request body
|
|
1071
|
+
# is determined by protos JSON encoding: HTTP | gRPC -----|----- `PATCH /v1/
|
|
1072
|
+
# messages/123456 ` "text": "Hi!" `` | `UpdateMessage(message_id: "123456"
|
|
1073
|
+
# message ` text: "Hi!" `)` The special name `*` can be used in the body mapping
|
|
1074
|
+
# to define that every field not bound by the path template should be mapped to
|
|
1075
|
+
# the request body. This enables the following alternative definition of the
|
|
1076
|
+
# update method: service Messaging ` rpc UpdateMessage(Message) returns (Message)
|
|
1077
|
+
# ` option (google.api.http) = ` patch: "/v1/messages/`message_id`" body: "*" `;
|
|
1078
|
+
# ` ` message Message ` string message_id = 1; string text = 2; ` The following
|
|
1079
|
+
# HTTP JSON to RPC mapping is enabled: HTTP | gRPC -----|----- `PATCH /v1/
|
|
1080
|
+
# messages/123456 ` "text": "Hi!" `` | `UpdateMessage(message_id: "123456" text:
|
|
1081
|
+
# "Hi!")` Note that when using `*` in the body mapping, it is not possible to
|
|
1082
|
+
# have HTTP parameters, as all fields not bound by the path end in the body.
|
|
1083
|
+
# This makes this option more rarely used in practice when defining REST APIs.
|
|
1084
|
+
# The common usage of `*` is in custom methods which don't use the URL at all
|
|
1085
|
+
# for transferring data. It is possible to define multiple HTTP methods for one
|
|
1086
|
+
# RPC by using the `additional_bindings` option. Example: service Messaging `
|
|
1087
|
+
# rpc GetMessage(GetMessageRequest) returns (Message) ` option (google.api.http)
|
|
1088
|
+
# = ` get: "/v1/messages/`message_id`" additional_bindings ` get: "/v1/users/`
|
|
1089
|
+
# user_id`/messages/`message_id`" ` `; ` ` message GetMessageRequest ` string
|
|
1090
|
+
# message_id = 1; string user_id = 2; ` This enables the following two
|
|
1091
|
+
# alternative HTTP JSON to RPC mappings: HTTP | gRPC -----|----- `GET /v1/
|
|
1092
|
+
# messages/123456` | `GetMessage(message_id: "123456")` `GET /v1/users/me/
|
|
1093
|
+
# messages/123456` | `GetMessage(user_id: "me" message_id: "123456")` ## Rules
|
|
1094
|
+
# for HTTP mapping 1. Leaf request fields (recursive expansion nested messages
|
|
1095
|
+
# in the request message) are classified into three categories: - Fields
|
|
1096
|
+
# referred by the path template. They are passed via the URL path. - Fields
|
|
1097
|
+
# referred by the HttpRule.body. They are passed via the HTTP request body. -
|
|
1098
|
+
# All other fields are passed via the URL query parameters, and the parameter
|
|
1099
|
+
# name is the field path in the request message. A repeated field can be
|
|
1100
|
+
# represented as multiple query parameters under the same name. 2. If HttpRule.
|
|
1101
|
+
# body is "*", there is no URL query parameter, all fields are passed via URL
|
|
1102
|
+
# path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP
|
|
1103
|
+
# request body, all fields are passed via URL path and URL query parameters. ###
|
|
1104
|
+
# Path template syntax Template = "/" Segments [ Verb ] ; Segments = Segment ` "/
|
|
1105
|
+
# " Segment ` ; Segment = "*" | "**" | LITERAL | Variable ; Variable = "`"
|
|
1106
|
+
# FieldPath [ "=" Segments ] "`" ; FieldPath = IDENT ` "." IDENT ` ; Verb = ":"
|
|
1107
|
+
# LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**`
|
|
1108
|
+
# matches zero or more URL path segments, which must be the last part of the URL
|
|
1109
|
+
# path except the `Verb`. The syntax `Variable` matches part of the URL path as
|
|
1110
|
+
# specified by its template. A variable template must not contain other
|
|
1111
|
+
# variables. If a variable matches a single path segment, its template may be
|
|
1112
|
+
# omitted, e.g. ``var`` is equivalent to ``var=*``. The syntax `LITERAL` matches
|
|
1113
|
+
# literal text in the URL path. If the `LITERAL` contains any reserved character,
|
|
1114
|
+
# such characters should be percent-encoded before the matching. If a variable
|
|
1115
|
+
# contains exactly one path segment, such as `"`var`"` or `"`var=*`"`, when such
|
|
1116
|
+
# a variable is expanded into a URL path on the client side, all characters
|
|
1117
|
+
# except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse
|
|
1118
|
+
# decoding. Such variables show up in the [Discovery Document](https://
|
|
1119
|
+
# developers.google.com/discovery/v1/reference/apis) as ``var``. If a variable
|
|
1120
|
+
# contains multiple path segments, such as `"`var=foo/*`"` or `"`var=**`"`, when
|
|
1121
|
+
# such a variable is expanded into a URL path on the client side, all characters
|
|
1122
|
+
# except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the
|
|
1123
|
+
# reverse decoding, except "%2F" and "%2f" are left unchanged. Such variables
|
|
1124
|
+
# show up in the [Discovery Document](https://developers.google.com/discovery/v1/
|
|
1125
|
+
# reference/apis) as ``+var``. ## Using gRPC API Service Configuration gRPC API
|
|
1126
|
+
# Service Configuration (service config) is a configuration language for
|
|
1127
|
+
# configuring a gRPC service to become a user-facing product. The service config
|
|
1128
|
+
# is simply the YAML representation of the `google.api.Service` proto message.
|
|
1354
1129
|
# As an alternative to annotating your proto file, you can configure gRPC
|
|
1355
|
-
# transcoding in your service config YAML files. You do this by specifying a
|
|
1356
|
-
#
|
|
1357
|
-
# effect as the proto annotation. This can be particularly useful if you
|
|
1358
|
-
#
|
|
1359
|
-
#
|
|
1360
|
-
#
|
|
1361
|
-
#
|
|
1362
|
-
#
|
|
1363
|
-
#
|
|
1364
|
-
#
|
|
1365
|
-
#
|
|
1366
|
-
#
|
|
1367
|
-
#
|
|
1368
|
-
#
|
|
1369
|
-
#
|
|
1370
|
-
#
|
|
1371
|
-
# .
|
|
1372
|
-
#
|
|
1373
|
-
#
|
|
1374
|
-
#
|
|
1375
|
-
#
|
|
1376
|
-
#
|
|
1377
|
-
#
|
|
1378
|
-
# for
|
|
1379
|
-
#
|
|
1380
|
-
#
|
|
1381
|
-
# The path variables **must not** capture the leading "/" character. The reason
|
|
1382
|
-
# is that the most common use case "`var`" does not capture the leading "/"
|
|
1383
|
-
# character. For consistency, all path variables must share the same behavior.
|
|
1384
|
-
# Repeated message fields must not be mapped to URL query parameters, because
|
|
1385
|
-
# no client library can support such complicated mapping.
|
|
1386
|
-
# If an API needs to use a JSON array for request or response body, it can map
|
|
1387
|
-
# the request or response body to a repeated field. However, some gRPC
|
|
1388
|
-
# Transcoding implementations may not support this feature.
|
|
1130
|
+
# transcoding in your service config YAML files. You do this by specifying a `
|
|
1131
|
+
# HttpRule` that maps the gRPC method to a REST endpoint, achieving the same
|
|
1132
|
+
# effect as the proto annotation. This can be particularly useful if you have a
|
|
1133
|
+
# proto that is reused in multiple services. Note that any transcoding specified
|
|
1134
|
+
# in the service config will override any matching transcoding configuration in
|
|
1135
|
+
# the proto. Example: http: rules: # Selects a gRPC method and applies HttpRule
|
|
1136
|
+
# to it. - selector: example.v1.Messaging.GetMessage get: /v1/messages/`
|
|
1137
|
+
# message_id`/`sub.subfield` ## Special notes When gRPC Transcoding is used to
|
|
1138
|
+
# map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow
|
|
1139
|
+
# the [proto3 specification](https://developers.google.com/protocol-buffers/docs/
|
|
1140
|
+
# proto3#json). While the single segment variable follows the semantics of [RFC
|
|
1141
|
+
# 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String
|
|
1142
|
+
# Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.
|
|
1143
|
+
# 3 Reserved Expansion. The reason is that the Reserved Expansion does not
|
|
1144
|
+
# expand special characters like `?` and `#`, which would lead to invalid URLs.
|
|
1145
|
+
# As the result, gRPC Transcoding uses a custom encoding for multi segment
|
|
1146
|
+
# variables. The path variables **must not** refer to any repeated or mapped
|
|
1147
|
+
# field, because client libraries are not capable of handling such variable
|
|
1148
|
+
# expansion. The path variables **must not** capture the leading "/" character.
|
|
1149
|
+
# The reason is that the most common use case "`var`" does not capture the
|
|
1150
|
+
# leading "/" character. For consistency, all path variables must share the same
|
|
1151
|
+
# behavior. Repeated message fields must not be mapped to URL query parameters,
|
|
1152
|
+
# because no client library can support such complicated mapping. If an API
|
|
1153
|
+
# needs to use a JSON array for request or response body, it can map the request
|
|
1154
|
+
# or response body to a repeated field. However, some gRPC Transcoding
|
|
1155
|
+
# implementations may not support this feature.
|
|
1389
1156
|
class HttpRule
|
|
1390
1157
|
include Google::Apis::Core::Hashable
|
|
1391
1158
|
|
|
1392
|
-
# Additional HTTP bindings for the selector. Nested bindings must
|
|
1393
|
-
#
|
|
1394
|
-
#
|
|
1159
|
+
# Additional HTTP bindings for the selector. Nested bindings must not contain an
|
|
1160
|
+
# `additional_bindings` field themselves (that is, the nesting may only be one
|
|
1161
|
+
# level deep).
|
|
1395
1162
|
# Corresponds to the JSON property `additionalBindings`
|
|
1396
1163
|
# @return [Array<Google::Apis::ServiceconsumermanagementV1beta1::HttpRule>]
|
|
1397
1164
|
attr_accessor :additional_bindings
|
|
1398
1165
|
|
|
1399
|
-
# When this flag is set to true, HTTP requests will be allowed to invoke a
|
|
1400
|
-
#
|
|
1166
|
+
# When this flag is set to true, HTTP requests will be allowed to invoke a half-
|
|
1167
|
+
# duplex streaming method.
|
|
1401
1168
|
# Corresponds to the JSON property `allowHalfDuplex`
|
|
1402
1169
|
# @return [Boolean]
|
|
1403
1170
|
attr_accessor :allow_half_duplex
|
|
1404
1171
|
alias_method :allow_half_duplex?, :allow_half_duplex
|
|
1405
1172
|
|
|
1406
|
-
# The name of the request field whose value is mapped to the HTTP request
|
|
1407
|
-
#
|
|
1408
|
-
#
|
|
1409
|
-
#
|
|
1410
|
-
# message type.
|
|
1173
|
+
# The name of the request field whose value is mapped to the HTTP request body,
|
|
1174
|
+
# or `*` for mapping all request fields not captured by the path pattern to the
|
|
1175
|
+
# HTTP body, or omitted for not having any HTTP request body. NOTE: the referred
|
|
1176
|
+
# field must be present at the top-level of the request message type.
|
|
1411
1177
|
# Corresponds to the JSON property `body`
|
|
1412
1178
|
# @return [String]
|
|
1413
1179
|
attr_accessor :body
|
|
@@ -1422,8 +1188,7 @@ module Google
|
|
|
1422
1188
|
# @return [String]
|
|
1423
1189
|
attr_accessor :delete
|
|
1424
1190
|
|
|
1425
|
-
# Maps to HTTP GET. Used for listing and getting information about
|
|
1426
|
-
# resources.
|
|
1191
|
+
# Maps to HTTP GET. Used for listing and getting information about resources.
|
|
1427
1192
|
# Corresponds to the JSON property `get`
|
|
1428
1193
|
# @return [String]
|
|
1429
1194
|
attr_accessor :get
|
|
@@ -1444,16 +1209,15 @@ module Google
|
|
|
1444
1209
|
attr_accessor :put
|
|
1445
1210
|
|
|
1446
1211
|
# Optional. The name of the response field whose value is mapped to the HTTP
|
|
1447
|
-
# response body. When omitted, the entire response message will be used
|
|
1448
|
-
#
|
|
1449
|
-
#
|
|
1450
|
-
# message type.
|
|
1212
|
+
# response body. When omitted, the entire response message will be used as the
|
|
1213
|
+
# HTTP response body. NOTE: The referred field must be present at the top-level
|
|
1214
|
+
# of the response message type.
|
|
1451
1215
|
# Corresponds to the JSON property `responseBody`
|
|
1452
1216
|
# @return [String]
|
|
1453
1217
|
attr_accessor :response_body
|
|
1454
1218
|
|
|
1455
|
-
# Selects a method to which this rule applies.
|
|
1456
|
-
#
|
|
1219
|
+
# Selects a method to which this rule applies. Refer to selector for syntax
|
|
1220
|
+
# details.
|
|
1457
1221
|
# Corresponds to the JSON property `selector`
|
|
1458
1222
|
# @return [String]
|
|
1459
1223
|
attr_accessor :selector
|
|
@@ -1492,13 +1256,12 @@ module Google
|
|
|
1492
1256
|
# @return [String]
|
|
1493
1257
|
attr_accessor :query
|
|
1494
1258
|
|
|
1495
|
-
# The value prefix. The value format is "value_prefix`token`"
|
|
1496
|
-
#
|
|
1497
|
-
#
|
|
1498
|
-
# If
|
|
1499
|
-
#
|
|
1500
|
-
#
|
|
1501
|
-
# value_prefix="Bearer " with a space at the end.
|
|
1259
|
+
# The value prefix. The value format is "value_prefix`token`" Only applies to "
|
|
1260
|
+
# in" header type. Must be empty for "in" query type. If not empty, the header
|
|
1261
|
+
# value has to match (case sensitive) this prefix. If not matched, JWT will not
|
|
1262
|
+
# be extracted. If matched, JWT will be extracted after the prefix is removed.
|
|
1263
|
+
# For example, for "Authorization: Bearer `JWT`", value_prefix="Bearer " with a
|
|
1264
|
+
# space at the end.
|
|
1502
1265
|
# Corresponds to the JSON property `valuePrefix`
|
|
1503
1266
|
# @return [String]
|
|
1504
1267
|
attr_accessor :value_prefix
|
|
@@ -1546,39 +1309,35 @@ module Google
|
|
|
1546
1309
|
end
|
|
1547
1310
|
end
|
|
1548
1311
|
|
|
1549
|
-
# A description of a log type. Example in YAML format:
|
|
1550
|
-
#
|
|
1551
|
-
#
|
|
1552
|
-
# display_name: Activity
|
|
1553
|
-
# labels:
|
|
1554
|
-
# - key: /customer_id
|
|
1312
|
+
# A description of a log type. Example in YAML format: - name: library.
|
|
1313
|
+
# googleapis.com/activity_history description: The history of borrowing and
|
|
1314
|
+
# returning library items. display_name: Activity labels: - key: /customer_id
|
|
1555
1315
|
# description: Identifier of a library customer
|
|
1556
1316
|
class LogDescriptor
|
|
1557
1317
|
include Google::Apis::Core::Hashable
|
|
1558
1318
|
|
|
1559
|
-
# A human-readable description of this log. This information appears in
|
|
1560
|
-
#
|
|
1319
|
+
# A human-readable description of this log. This information appears in the
|
|
1320
|
+
# documentation and can contain details.
|
|
1561
1321
|
# Corresponds to the JSON property `description`
|
|
1562
1322
|
# @return [String]
|
|
1563
1323
|
attr_accessor :description
|
|
1564
1324
|
|
|
1565
|
-
# The human-readable name for this log. This information appears on
|
|
1566
|
-
#
|
|
1325
|
+
# The human-readable name for this log. This information appears on the user
|
|
1326
|
+
# interface and should be concise.
|
|
1567
1327
|
# Corresponds to the JSON property `displayName`
|
|
1568
1328
|
# @return [String]
|
|
1569
1329
|
attr_accessor :display_name
|
|
1570
1330
|
|
|
1571
|
-
# The set of labels that are available to describe a specific log entry.
|
|
1572
|
-
#
|
|
1573
|
-
# considered invalid.
|
|
1331
|
+
# The set of labels that are available to describe a specific log entry. Runtime
|
|
1332
|
+
# requests that contain labels not specified here are considered invalid.
|
|
1574
1333
|
# Corresponds to the JSON property `labels`
|
|
1575
1334
|
# @return [Array<Google::Apis::ServiceconsumermanagementV1beta1::LabelDescriptor>]
|
|
1576
1335
|
attr_accessor :labels
|
|
1577
1336
|
|
|
1578
|
-
# The name of the log. It must be less than 512 characters long and can
|
|
1579
|
-
#
|
|
1580
|
-
#
|
|
1581
|
-
#
|
|
1337
|
+
# The name of the log. It must be less than 512 characters long and can include
|
|
1338
|
+
# the following characters: upper- and lower-case alphanumeric characters [A-Za-
|
|
1339
|
+
# z0-9], and punctuation characters including slash, underscore, hyphen, period [
|
|
1340
|
+
# /_-.].
|
|
1582
1341
|
# Corresponds to the JSON property `name`
|
|
1583
1342
|
# @return [String]
|
|
1584
1343
|
attr_accessor :name
|
|
@@ -1596,48 +1355,30 @@ module Google
|
|
|
1596
1355
|
end
|
|
1597
1356
|
end
|
|
1598
1357
|
|
|
1599
|
-
# Logging configuration of the service.
|
|
1600
|
-
#
|
|
1601
|
-
#
|
|
1602
|
-
# log is sent to
|
|
1603
|
-
#
|
|
1604
|
-
#
|
|
1605
|
-
# -
|
|
1606
|
-
# labels:
|
|
1607
|
-
# -
|
|
1608
|
-
#
|
|
1609
|
-
#
|
|
1610
|
-
# description: The name of the branch.
|
|
1611
|
-
# logs:
|
|
1612
|
-
# - name: activity_history
|
|
1613
|
-
# labels:
|
|
1614
|
-
# - key: /customer_id
|
|
1615
|
-
# - name: purchase_history
|
|
1616
|
-
# logging:
|
|
1617
|
-
# producer_destinations:
|
|
1618
|
-
# - monitored_resource: library.googleapis.com/branch
|
|
1619
|
-
# logs:
|
|
1620
|
-
# - activity_history
|
|
1621
|
-
# - purchase_history
|
|
1622
|
-
# consumer_destinations:
|
|
1623
|
-
# - monitored_resource: library.googleapis.com/branch
|
|
1624
|
-
# logs:
|
|
1625
|
-
# - activity_history
|
|
1358
|
+
# Logging configuration of the service. The following example shows how to
|
|
1359
|
+
# configure logs to be sent to the producer and consumer projects. In the
|
|
1360
|
+
# example, the `activity_history` log is sent to both the producer and consumer
|
|
1361
|
+
# projects, whereas the `purchase_history` log is only sent to the producer
|
|
1362
|
+
# project. monitored_resources: - type: library.googleapis.com/branch labels: -
|
|
1363
|
+
# key: /city description: The city where the library branch is located in. - key:
|
|
1364
|
+
# /name description: The name of the branch. logs: - name: activity_history
|
|
1365
|
+
# labels: - key: /customer_id - name: purchase_history logging:
|
|
1366
|
+
# producer_destinations: - monitored_resource: library.googleapis.com/branch
|
|
1367
|
+
# logs: - activity_history - purchase_history consumer_destinations: -
|
|
1368
|
+
# monitored_resource: library.googleapis.com/branch logs: - activity_history
|
|
1626
1369
|
class Logging
|
|
1627
1370
|
include Google::Apis::Core::Hashable
|
|
1628
1371
|
|
|
1629
|
-
# Logging configurations for sending logs to the consumer project.
|
|
1630
|
-
#
|
|
1631
|
-
#
|
|
1632
|
-
# one consumer destination.
|
|
1372
|
+
# Logging configurations for sending logs to the consumer project. There can be
|
|
1373
|
+
# multiple consumer destinations, each one must have a different monitored
|
|
1374
|
+
# resource type. A log can be used in at most one consumer destination.
|
|
1633
1375
|
# Corresponds to the JSON property `consumerDestinations`
|
|
1634
1376
|
# @return [Array<Google::Apis::ServiceconsumermanagementV1beta1::LoggingDestination>]
|
|
1635
1377
|
attr_accessor :consumer_destinations
|
|
1636
1378
|
|
|
1637
|
-
# Logging configurations for sending logs to the producer project.
|
|
1638
|
-
#
|
|
1639
|
-
#
|
|
1640
|
-
# one producer destination.
|
|
1379
|
+
# Logging configurations for sending logs to the producer project. There can be
|
|
1380
|
+
# multiple producer destinations, each one must have a different monitored
|
|
1381
|
+
# resource type. A log can be used in at most one producer destination.
|
|
1641
1382
|
# Corresponds to the JSON property `producerDestinations`
|
|
1642
1383
|
# @return [Array<Google::Apis::ServiceconsumermanagementV1beta1::LoggingDestination>]
|
|
1643
1384
|
attr_accessor :producer_destinations
|
|
@@ -1653,21 +1394,20 @@ module Google
|
|
|
1653
1394
|
end
|
|
1654
1395
|
end
|
|
1655
1396
|
|
|
1656
|
-
# Configuration of a specific logging destination (the producer project
|
|
1657
|
-
#
|
|
1397
|
+
# Configuration of a specific logging destination (the producer project or the
|
|
1398
|
+
# consumer project).
|
|
1658
1399
|
class LoggingDestination
|
|
1659
1400
|
include Google::Apis::Core::Hashable
|
|
1660
1401
|
|
|
1661
|
-
# Names of the logs to be sent to this destination. Each name must
|
|
1662
|
-
#
|
|
1663
|
-
#
|
|
1664
|
-
# the service name followed by "/".
|
|
1402
|
+
# Names of the logs to be sent to this destination. Each name must be defined in
|
|
1403
|
+
# the Service.logs section. If the log name is not a domain scoped name, it will
|
|
1404
|
+
# be automatically prefixed with the service name followed by "/".
|
|
1665
1405
|
# Corresponds to the JSON property `logs`
|
|
1666
1406
|
# @return [Array<String>]
|
|
1667
1407
|
attr_accessor :logs
|
|
1668
1408
|
|
|
1669
|
-
# The monitored resource type. The type must be defined in the
|
|
1670
|
-
#
|
|
1409
|
+
# The monitored resource type. The type must be defined in the Service.
|
|
1410
|
+
# monitored_resources section.
|
|
1671
1411
|
# Corresponds to the JSON property `monitoredResource`
|
|
1672
1412
|
# @return [String]
|
|
1673
1413
|
attr_accessor :monitored_resource
|
|
@@ -1742,16 +1482,13 @@ module Google
|
|
|
1742
1482
|
|
|
1743
1483
|
# Defines a metric type and its schema. Once a metric descriptor is created,
|
|
1744
1484
|
# deleting or altering it stops data collection and makes the metric type's
|
|
1745
|
-
# existing data unusable.
|
|
1746
|
-
#
|
|
1747
|
-
#
|
|
1748
|
-
#
|
|
1749
|
-
#
|
|
1750
|
-
#
|
|
1751
|
-
#
|
|
1752
|
-
# * Maximum of default 10 labels per metric descriptor is allowed.
|
|
1753
|
-
# The default maximum limit can be overridden. Please follow
|
|
1754
|
-
# https://cloud.google.com/monitoring/quotas
|
|
1485
|
+
# existing data unusable. The following are specific rules for service defined
|
|
1486
|
+
# Monitoring metric descriptors: * `type`, `metric_kind`, `value_type` and `
|
|
1487
|
+
# description` fields are all required. The `unit` field must be specified if
|
|
1488
|
+
# the `value_type` is any of DOUBLE, INT64, DISTRIBUTION. * Maximum of default
|
|
1489
|
+
# 500 metric descriptors per service is allowed. * Maximum of default 10 labels
|
|
1490
|
+
# per metric descriptor is allowed. The default maximum limit can be overridden.
|
|
1491
|
+
# Please follow https://cloud.google.com/monitoring/quotas
|
|
1755
1492
|
class MetricDescriptor
|
|
1756
1493
|
include Google::Apis::Core::Hashable
|
|
1757
1494
|
|
|
@@ -1760,26 +1497,21 @@ module Google
|
|
|
1760
1497
|
# @return [String]
|
|
1761
1498
|
attr_accessor :description
|
|
1762
1499
|
|
|
1763
|
-
# A concise name for the metric, which can be displayed in user interfaces.
|
|
1764
|
-
#
|
|
1765
|
-
#
|
|
1766
|
-
#
|
|
1500
|
+
# A concise name for the metric, which can be displayed in user interfaces. Use
|
|
1501
|
+
# sentence case without an ending period, for example "Request count". This
|
|
1502
|
+
# field is optional but it is recommended to be set for any metrics associated
|
|
1503
|
+
# with user-visible concepts, such as Quota.
|
|
1767
1504
|
# Corresponds to the JSON property `displayName`
|
|
1768
1505
|
# @return [String]
|
|
1769
1506
|
attr_accessor :display_name
|
|
1770
1507
|
|
|
1771
|
-
# The set of labels that can be used to describe a specific
|
|
1772
|
-
#
|
|
1773
|
-
#
|
|
1774
|
-
# *
|
|
1775
|
-
#
|
|
1776
|
-
#
|
|
1777
|
-
#
|
|
1778
|
-
# For example, the
|
|
1779
|
-
# `appengine.googleapis.com/http/server/response_latencies` metric
|
|
1780
|
-
# type has a label for the HTTP response code, `response_code`, so
|
|
1781
|
-
# you can look at latencies for successful responses or just
|
|
1782
|
-
# for responses that failed.
|
|
1508
|
+
# The set of labels that can be used to describe a specific instance of this
|
|
1509
|
+
# metric type. The label key name must follow: * Only upper and lower-case
|
|
1510
|
+
# letters, digits and underscores (_) are allowed. * Label name must start with
|
|
1511
|
+
# a letter or digit. * The maximum length of a label name is 100 characters. For
|
|
1512
|
+
# example, the `appengine.googleapis.com/http/server/response_latencies` metric
|
|
1513
|
+
# type has a label for the HTTP response code, `response_code`, so you can look
|
|
1514
|
+
# at latencies for successful responses or just for responses that failed.
|
|
1783
1515
|
# Corresponds to the JSON property `labels`
|
|
1784
1516
|
# @return [Array<Google::Apis::ServiceconsumermanagementV1beta1::LabelDescriptor>]
|
|
1785
1517
|
attr_accessor :labels
|
|
@@ -1794,17 +1526,16 @@ module Google
|
|
|
1794
1526
|
# @return [Google::Apis::ServiceconsumermanagementV1beta1::MetricDescriptorMetadata]
|
|
1795
1527
|
attr_accessor :metadata
|
|
1796
1528
|
|
|
1797
|
-
# Whether the metric records instantaneous values, changes to a value, etc.
|
|
1798
|
-
#
|
|
1529
|
+
# Whether the metric records instantaneous values, changes to a value, etc. Some
|
|
1530
|
+
# combinations of `metric_kind` and `value_type` might not be supported.
|
|
1799
1531
|
# Corresponds to the JSON property `metricKind`
|
|
1800
1532
|
# @return [String]
|
|
1801
1533
|
attr_accessor :metric_kind
|
|
1802
1534
|
|
|
1803
|
-
# Read-only. If present, then a time
|
|
1804
|
-
#
|
|
1805
|
-
#
|
|
1806
|
-
#
|
|
1807
|
-
# resource types listed here.
|
|
1535
|
+
# Read-only. If present, then a time series, which is identified partially by a
|
|
1536
|
+
# metric type and a MonitoredResourceDescriptor, that is associated with this
|
|
1537
|
+
# metric type can only be associated with one of the monitored resource types
|
|
1538
|
+
# listed here.
|
|
1808
1539
|
# Corresponds to the JSON property `monitoredResourceTypes`
|
|
1809
1540
|
# @return [Array<String>]
|
|
1810
1541
|
attr_accessor :monitored_resource_types
|
|
@@ -1814,116 +1545,73 @@ module Google
|
|
|
1814
1545
|
# @return [String]
|
|
1815
1546
|
attr_accessor :name
|
|
1816
1547
|
|
|
1817
|
-
# The metric type, including its DNS name prefix. The type is not
|
|
1818
|
-
# URL-encoded.
|
|
1548
|
+
# The metric type, including its DNS name prefix. The type is not URL-encoded.
|
|
1819
1549
|
# All service defined metrics must be prefixed with the service name, in the
|
|
1820
|
-
# format of ``service name`/`relative metric name``, such as
|
|
1821
|
-
#
|
|
1822
|
-
# name must follow:
|
|
1550
|
+
# format of ``service name`/`relative metric name``, such as `cloudsql.
|
|
1551
|
+
# googleapis.com/database/cpu/utilization`. The relative metric name must follow:
|
|
1823
1552
|
# * Only upper and lower-case letters, digits, '/' and underscores '_' are
|
|
1824
|
-
# allowed.
|
|
1825
|
-
#
|
|
1826
|
-
#
|
|
1827
|
-
#
|
|
1828
|
-
#
|
|
1829
|
-
#
|
|
1830
|
-
# Metric types should use a natural hierarchical grouping. For example:
|
|
1831
|
-
# "custom.googleapis.com/invoice/paid/amount"
|
|
1832
|
-
# "external.googleapis.com/prometheus/up"
|
|
1833
|
-
# "appengine.googleapis.com/http/server/response_latencies"
|
|
1553
|
+
# allowed. * The maximum number of characters allowed for the
|
|
1554
|
+
# relative_metric_name is 100. All user-defined metric types have the DNS name `
|
|
1555
|
+
# custom.googleapis.com`, `external.googleapis.com`, or `logging.googleapis.com/
|
|
1556
|
+
# user/`. Metric types should use a natural hierarchical grouping. For example: "
|
|
1557
|
+
# custom.googleapis.com/invoice/paid/amount" "external.googleapis.com/prometheus/
|
|
1558
|
+
# up" "appengine.googleapis.com/http/server/response_latencies"
|
|
1834
1559
|
# Corresponds to the JSON property `type`
|
|
1835
1560
|
# @return [String]
|
|
1836
1561
|
attr_accessor :type
|
|
1837
1562
|
|
|
1838
|
-
# The units in which the metric value is reported. It is only applicable
|
|
1839
|
-
#
|
|
1840
|
-
#
|
|
1841
|
-
#
|
|
1842
|
-
# value of `
|
|
1843
|
-
#
|
|
1844
|
-
#
|
|
1845
|
-
#
|
|
1846
|
-
#
|
|
1847
|
-
#
|
|
1848
|
-
# `
|
|
1849
|
-
#
|
|
1850
|
-
#
|
|
1851
|
-
#
|
|
1852
|
-
#
|
|
1853
|
-
#
|
|
1854
|
-
#
|
|
1855
|
-
#
|
|
1856
|
-
#
|
|
1857
|
-
# * `
|
|
1858
|
-
# * `
|
|
1859
|
-
# * `
|
|
1860
|
-
# * `
|
|
1861
|
-
# * `
|
|
1862
|
-
#
|
|
1863
|
-
#
|
|
1864
|
-
#
|
|
1865
|
-
#
|
|
1866
|
-
#
|
|
1867
|
-
#
|
|
1868
|
-
# * `
|
|
1869
|
-
#
|
|
1870
|
-
# * `
|
|
1871
|
-
#
|
|
1872
|
-
# * `
|
|
1873
|
-
#
|
|
1874
|
-
#
|
|
1875
|
-
#
|
|
1876
|
-
#
|
|
1877
|
-
#
|
|
1878
|
-
# *
|
|
1879
|
-
#
|
|
1880
|
-
#
|
|
1881
|
-
# * `
|
|
1882
|
-
#
|
|
1883
|
-
#
|
|
1884
|
-
# * `Ti` tebi (2^40)
|
|
1885
|
-
# * `Pi` pebi (2^50)
|
|
1886
|
-
# **Grammar**
|
|
1887
|
-
# The grammar also includes these connectors:
|
|
1888
|
-
# * `/` division or ratio (as an infix operator). For examples,
|
|
1889
|
-
# `kBy/`email`` or `MiBy/10ms` (although you should almost never
|
|
1890
|
-
# have `/s` in a metric `unit`; rates should always be computed at
|
|
1891
|
-
# query time from the underlying cumulative or delta value).
|
|
1892
|
-
# * `.` multiplication or composition (as an infix operator). For
|
|
1893
|
-
# examples, `GBy.d` or `k`watt`.h`.
|
|
1894
|
-
# The grammar for a unit is as follows:
|
|
1895
|
-
# Expression = Component ` "." Component ` ` "/" Component ` ;
|
|
1896
|
-
# Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ]
|
|
1897
|
-
# | Annotation
|
|
1898
|
-
# | "1"
|
|
1899
|
-
# ;
|
|
1900
|
-
# Annotation = "`" NAME "`" ;
|
|
1901
|
-
# Notes:
|
|
1902
|
-
# * `Annotation` is just a comment if it follows a `UNIT`. If the annotation
|
|
1903
|
-
# is used alone, then the unit is equivalent to `1`. For examples,
|
|
1904
|
-
# ``request`/s == 1/s`, `By`transmitted`/s == By/s`.
|
|
1905
|
-
# * `NAME` is a sequence of non-blank printable ASCII characters not
|
|
1906
|
-
# containing ``` or ```.
|
|
1907
|
-
# * `1` represents a unitary [dimensionless
|
|
1908
|
-
# unit](https://en.wikipedia.org/wiki/Dimensionless_quantity) of 1, such
|
|
1909
|
-
# as in `1/s`. It is typically used when none of the basic units are
|
|
1910
|
-
# appropriate. For example, "new users per day" can be represented as
|
|
1911
|
-
# `1/d` or ``new-users`/d` (and a metric value `5` would mean "5 new
|
|
1912
|
-
# users). Alternatively, "thousands of page views per day" would be
|
|
1913
|
-
# represented as `1000/d` or `k1/d` or `k`page_views`/d` (and a metric
|
|
1914
|
-
# value of `5.3` would mean "5300 page views per day").
|
|
1915
|
-
# * `%` represents dimensionless value of 1/100, and annotates values giving
|
|
1916
|
-
# a percentage (so the metric values are typically in the range of 0..100,
|
|
1917
|
-
# and a metric value `3` means "3 percent").
|
|
1918
|
-
# * `10^2.%` indicates a metric contains a ratio, typically in the range
|
|
1919
|
-
# 0..1, that will be multiplied by 100 and displayed as a percentage
|
|
1920
|
-
# (so a metric value `0.03` means "3 percent").
|
|
1563
|
+
# The units in which the metric value is reported. It is only applicable if the `
|
|
1564
|
+
# value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The `unit` defines the
|
|
1565
|
+
# representation of the stored metric values. Different systems may scale the
|
|
1566
|
+
# values to be more easily displayed (so a value of `0.02KBy` _might_ be
|
|
1567
|
+
# displayed as `20By`, and a value of `3523KBy` _might_ be displayed as `3.5MBy`)
|
|
1568
|
+
# . However, if the `unit` is `KBy`, then the value of the metric is always in
|
|
1569
|
+
# thousands of bytes, no matter how it may be displayed.. If you want a custom
|
|
1570
|
+
# metric to record the exact number of CPU-seconds used by a job, you can create
|
|
1571
|
+
# an `INT64 CUMULATIVE` metric whose `unit` is `s`CPU`` (or equivalently `1s`CPU`
|
|
1572
|
+
# ` or just `s`). If the job uses 12,005 CPU-seconds, then the value is written
|
|
1573
|
+
# as `12005`. Alternatively, if you want a custom metric to record data in a
|
|
1574
|
+
# more granular way, you can create a `DOUBLE CUMULATIVE` metric whose `unit` is
|
|
1575
|
+
# `ks`CPU``, and then write the value `12.005` (which is `12005/1000`), or use `
|
|
1576
|
+
# Kis`CPU`` and write `11.723` (which is `12005/1024`). The supported units are
|
|
1577
|
+
# a subset of [The Unified Code for Units of Measure](http://unitsofmeasure.org/
|
|
1578
|
+
# ucum.html) standard: **Basic units (UNIT)** * `bit` bit * `By` byte * `s`
|
|
1579
|
+
# second * `min` minute * `h` hour * `d` day * `1` dimensionless **Prefixes (
|
|
1580
|
+
# PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga (10^9) * `T` tera (10^
|
|
1581
|
+
# 12) * `P` peta (10^15) * `E` exa (10^18) * `Z` zetta (10^21) * `Y` yotta (10^
|
|
1582
|
+
# 24) * `m` milli (10^-3) * `u` micro (10^-6) * `n` nano (10^-9) * `p` pico (10^-
|
|
1583
|
+
# 12) * `f` femto (10^-15) * `a` atto (10^-18) * `z` zepto (10^-21) * `y` yocto (
|
|
1584
|
+
# 10^-24) * `Ki` kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (
|
|
1585
|
+
# 2^40) * `Pi` pebi (2^50) **Grammar** The grammar also includes these
|
|
1586
|
+
# connectors: * `/` division or ratio (as an infix operator). For examples, `kBy/
|
|
1587
|
+
# `email`` or `MiBy/10ms` (although you should almost never have `/s` in a
|
|
1588
|
+
# metric `unit`; rates should always be computed at query time from the
|
|
1589
|
+
# underlying cumulative or delta value). * `.` multiplication or composition (as
|
|
1590
|
+
# an infix operator). For examples, `GBy.d` or `k`watt`.h`. The grammar for a
|
|
1591
|
+
# unit is as follows: Expression = Component ` "." Component ` ` "/" Component `
|
|
1592
|
+
# ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ;
|
|
1593
|
+
# Annotation = "`" NAME "`" ; Notes: * `Annotation` is just a comment if it
|
|
1594
|
+
# follows a `UNIT`. If the annotation is used alone, then the unit is equivalent
|
|
1595
|
+
# to `1`. For examples, ``request`/s == 1/s`, `By`transmitted`/s == By/s`. * `
|
|
1596
|
+
# NAME` is a sequence of non-blank printable ASCII characters not containing ```
|
|
1597
|
+
# or ```. * `1` represents a unitary [dimensionless unit](https://en.wikipedia.
|
|
1598
|
+
# org/wiki/Dimensionless_quantity) of 1, such as in `1/s`. It is typically used
|
|
1599
|
+
# when none of the basic units are appropriate. For example, "new users per day"
|
|
1600
|
+
# can be represented as `1/d` or ``new-users`/d` (and a metric value `5` would
|
|
1601
|
+
# mean "5 new users). Alternatively, "thousands of page views per day" would be
|
|
1602
|
+
# represented as `1000/d` or `k1/d` or `k`page_views`/d` (and a metric value of `
|
|
1603
|
+
# 5.3` would mean "5300 page views per day"). * `%` represents dimensionless
|
|
1604
|
+
# value of 1/100, and annotates values giving a percentage (so the metric values
|
|
1605
|
+
# are typically in the range of 0..100, and a metric value `3` means "3 percent")
|
|
1606
|
+
# . * `10^2.%` indicates a metric contains a ratio, typically in the range 0..1,
|
|
1607
|
+
# that will be multiplied by 100 and displayed as a percentage (so a metric
|
|
1608
|
+
# value `0.03` means "3 percent").
|
|
1921
1609
|
# Corresponds to the JSON property `unit`
|
|
1922
1610
|
# @return [String]
|
|
1923
1611
|
attr_accessor :unit
|
|
1924
1612
|
|
|
1925
|
-
# Whether the measurement is an integer, a floating-point number, etc.
|
|
1926
|
-
#
|
|
1613
|
+
# Whether the measurement is an integer, a floating-point number, etc. Some
|
|
1614
|
+
# combinations of `metric_kind` and `value_type` might not be supported.
|
|
1927
1615
|
# Corresponds to the JSON property `valueType`
|
|
1928
1616
|
# @return [String]
|
|
1929
1617
|
attr_accessor :value_type
|
|
@@ -1952,9 +1640,9 @@ module Google
|
|
|
1952
1640
|
class MetricDescriptorMetadata
|
|
1953
1641
|
include Google::Apis::Core::Hashable
|
|
1954
1642
|
|
|
1955
|
-
# The delay of data points caused by ingestion. Data points older than this
|
|
1956
|
-
#
|
|
1957
|
-
#
|
|
1643
|
+
# The delay of data points caused by ingestion. Data points older than this age
|
|
1644
|
+
# are guaranteed to be ingested and available to be read, excluding data loss
|
|
1645
|
+
# due to errors.
|
|
1958
1646
|
# Corresponds to the JSON property `ingestDelay`
|
|
1959
1647
|
# @return [String]
|
|
1960
1648
|
attr_accessor :ingest_delay
|
|
@@ -1966,8 +1654,8 @@ module Google
|
|
|
1966
1654
|
|
|
1967
1655
|
# The sampling period of metric data points. For metrics which are written
|
|
1968
1656
|
# periodically, consecutive data points are stored at this time interval,
|
|
1969
|
-
# excluding data loss due to errors. Metrics with a higher granularity have
|
|
1970
|
-
#
|
|
1657
|
+
# excluding data loss due to errors. Metrics with a higher granularity have a
|
|
1658
|
+
# smaller sampling period.
|
|
1971
1659
|
# Corresponds to the JSON property `samplePeriod`
|
|
1972
1660
|
# @return [String]
|
|
1973
1661
|
attr_accessor :sample_period
|
|
@@ -1984,22 +1672,21 @@ module Google
|
|
|
1984
1672
|
end
|
|
1985
1673
|
end
|
|
1986
1674
|
|
|
1987
|
-
# Bind API methods to metrics. Binding a method to a metric causes that
|
|
1988
|
-
#
|
|
1675
|
+
# Bind API methods to metrics. Binding a method to a metric causes that metric's
|
|
1676
|
+
# configured quota behaviors to apply to the method call.
|
|
1989
1677
|
class MetricRule
|
|
1990
1678
|
include Google::Apis::Core::Hashable
|
|
1991
1679
|
|
|
1992
1680
|
# Metrics to update when the selected methods are called, and the associated
|
|
1993
|
-
# cost applied to each metric.
|
|
1994
|
-
#
|
|
1995
|
-
#
|
|
1996
|
-
# The value must not be negative.
|
|
1681
|
+
# cost applied to each metric. The key of the map is the metric name, and the
|
|
1682
|
+
# values are the amount increased for the metric against which the quota limits
|
|
1683
|
+
# are defined. The value must not be negative.
|
|
1997
1684
|
# Corresponds to the JSON property `metricCosts`
|
|
1998
1685
|
# @return [Hash<String,Fixnum>]
|
|
1999
1686
|
attr_accessor :metric_costs
|
|
2000
1687
|
|
|
2001
|
-
# Selects the methods to which this rule applies.
|
|
2002
|
-
#
|
|
1688
|
+
# Selects the methods to which this rule applies. Refer to selector for syntax
|
|
1689
|
+
# details.
|
|
2003
1690
|
# Corresponds to the JSON property `selector`
|
|
2004
1691
|
# @return [String]
|
|
2005
1692
|
attr_accessor :selector
|
|
@@ -2017,66 +1704,33 @@ module Google
|
|
|
2017
1704
|
|
|
2018
1705
|
# Declares an API Interface to be included in this interface. The including
|
|
2019
1706
|
# interface must redeclare all the methods from the included interface, but
|
|
2020
|
-
# documentation and options are inherited as follows:
|
|
2021
|
-
#
|
|
2022
|
-
#
|
|
2023
|
-
#
|
|
2024
|
-
#
|
|
2025
|
-
#
|
|
2026
|
-
#
|
|
2027
|
-
#
|
|
2028
|
-
#
|
|
2029
|
-
#
|
|
2030
|
-
#
|
|
2031
|
-
#
|
|
2032
|
-
#
|
|
2033
|
-
#
|
|
2034
|
-
#
|
|
2035
|
-
#
|
|
2036
|
-
#
|
|
2037
|
-
# `
|
|
2038
|
-
# `
|
|
2039
|
-
#
|
|
2040
|
-
#
|
|
2041
|
-
#
|
|
2042
|
-
#
|
|
2043
|
-
#
|
|
2044
|
-
#
|
|
2045
|
-
# `
|
|
2046
|
-
# `
|
|
2047
|
-
# Example of a mixin configuration:
|
|
2048
|
-
# apis:
|
|
2049
|
-
# - name: google.storage.v2.Storage
|
|
2050
|
-
# mixins:
|
|
2051
|
-
# - name: google.acl.v1.AccessControl
|
|
2052
|
-
# The mixin construct implies that all methods in `AccessControl` are
|
|
2053
|
-
# also declared with same name and request/response types in
|
|
2054
|
-
# `Storage`. A documentation generator or annotation processor will
|
|
2055
|
-
# see the effective `Storage.GetAcl` method after inherting
|
|
2056
|
-
# documentation and annotations as follows:
|
|
2057
|
-
# service Storage `
|
|
2058
|
-
# // Get the underlying ACL object.
|
|
2059
|
-
# rpc GetAcl(GetAclRequest) returns (Acl) `
|
|
2060
|
-
# option (google.api.http).get = "/v2/`resource=**`:getAcl";
|
|
2061
|
-
# `
|
|
2062
|
-
# ...
|
|
2063
|
-
# `
|
|
2064
|
-
# Note how the version in the path pattern changed from `v1` to `v2`.
|
|
2065
|
-
# If the `root` field in the mixin is specified, it should be a
|
|
2066
|
-
# relative path under which inherited HTTP paths are placed. Example:
|
|
2067
|
-
# apis:
|
|
2068
|
-
# - name: google.storage.v2.Storage
|
|
2069
|
-
# mixins:
|
|
2070
|
-
# - name: google.acl.v1.AccessControl
|
|
2071
|
-
# root: acls
|
|
2072
|
-
# This implies the following inherited HTTP annotation:
|
|
2073
|
-
# service Storage `
|
|
2074
|
-
# // Get the underlying ACL object.
|
|
2075
|
-
# rpc GetAcl(GetAclRequest) returns (Acl) `
|
|
2076
|
-
# option (google.api.http).get = "/v2/acls/`resource=**`:getAcl";
|
|
2077
|
-
# `
|
|
2078
|
-
# ...
|
|
2079
|
-
# `
|
|
1707
|
+
# documentation and options are inherited as follows: - If after comment and
|
|
1708
|
+
# whitespace stripping, the documentation string of the redeclared method is
|
|
1709
|
+
# empty, it will be inherited from the original method. - Each annotation
|
|
1710
|
+
# belonging to the service config (http, visibility) which is not set in the
|
|
1711
|
+
# redeclared method will be inherited. - If an http annotation is inherited, the
|
|
1712
|
+
# path pattern will be modified as follows. Any version prefix will be replaced
|
|
1713
|
+
# by the version of the including interface plus the root path if specified.
|
|
1714
|
+
# Example of a simple mixin: package google.acl.v1; service AccessControl ` //
|
|
1715
|
+
# Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) `
|
|
1716
|
+
# option (google.api.http).get = "/v1/`resource=**`:getAcl"; ` ` package google.
|
|
1717
|
+
# storage.v2; service Storage ` // rpc GetAcl(GetAclRequest) returns (Acl); //
|
|
1718
|
+
# Get a data record. rpc GetData(GetDataRequest) returns (Data) ` option (google.
|
|
1719
|
+
# api.http).get = "/v2/`resource=**`"; ` ` Example of a mixin configuration:
|
|
1720
|
+
# apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.
|
|
1721
|
+
# AccessControl The mixin construct implies that all methods in `AccessControl`
|
|
1722
|
+
# are also declared with same name and request/response types in `Storage`. A
|
|
1723
|
+
# documentation generator or annotation processor will see the effective `
|
|
1724
|
+
# Storage.GetAcl` method after inherting documentation and annotations as
|
|
1725
|
+
# follows: service Storage ` // Get the underlying ACL object. rpc GetAcl(
|
|
1726
|
+
# GetAclRequest) returns (Acl) ` option (google.api.http).get = "/v2/`resource=**
|
|
1727
|
+
# `:getAcl"; ` ... ` Note how the version in the path pattern changed from `v1`
|
|
1728
|
+
# to `v2`. If the `root` field in the mixin is specified, it should be a
|
|
1729
|
+
# relative path under which inherited HTTP paths are placed. Example: apis: -
|
|
1730
|
+
# name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl
|
|
1731
|
+
# root: acls This implies the following inherited HTTP annotation: service
|
|
1732
|
+
# Storage ` // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (
|
|
1733
|
+
# Acl) ` option (google.api.http).get = "/v2/acls/`resource=**`:getAcl"; ` ... `
|
|
2080
1734
|
class Mixin
|
|
2081
1735
|
include Google::Apis::Core::Hashable
|
|
2082
1736
|
|
|
@@ -2085,8 +1739,7 @@ module Google
|
|
|
2085
1739
|
# @return [String]
|
|
2086
1740
|
attr_accessor :name
|
|
2087
1741
|
|
|
2088
|
-
# If non-empty specifies a path under which inherited HTTP paths
|
|
2089
|
-
# are rooted.
|
|
1742
|
+
# If non-empty specifies a path under which inherited HTTP paths are rooted.
|
|
2090
1743
|
# Corresponds to the JSON property `root`
|
|
2091
1744
|
# @return [String]
|
|
2092
1745
|
attr_accessor :root
|
|
@@ -2102,51 +1755,42 @@ module Google
|
|
|
2102
1755
|
end
|
|
2103
1756
|
end
|
|
2104
1757
|
|
|
2105
|
-
# An object that describes the schema of a MonitoredResource object using a
|
|
2106
|
-
#
|
|
2107
|
-
#
|
|
2108
|
-
#
|
|
2109
|
-
#
|
|
2110
|
-
#
|
|
2111
|
-
#
|
|
2112
|
-
#
|
|
2113
|
-
#
|
|
2114
|
-
#
|
|
2115
|
-
#
|
|
2116
|
-
#
|
|
2117
|
-
#
|
|
2118
|
-
#
|
|
2119
|
-
# * Maximum of default 5 service defined monitored resource descriptors
|
|
2120
|
-
# is allowed per service.
|
|
2121
|
-
# * Maximum of default 10 labels per monitored resource is allowed.
|
|
2122
|
-
# The default maximum limit can be overridden. Please follow
|
|
2123
|
-
# https://cloud.google.com/monitoring/quotas
|
|
1758
|
+
# An object that describes the schema of a MonitoredResource object using a type
|
|
1759
|
+
# name and a set of labels. For example, the monitored resource descriptor for
|
|
1760
|
+
# Google Compute Engine VM instances has a type of `"gce_instance"` and
|
|
1761
|
+
# specifies the use of the labels `"instance_id"` and `"zone"` to identify
|
|
1762
|
+
# particular VM instances. Different services can support different monitored
|
|
1763
|
+
# resource types. The following are specific rules to service defined monitored
|
|
1764
|
+
# resources for Monitoring and Logging: * The `type`, `display_name`, `
|
|
1765
|
+
# description`, `labels` and `launch_stage` fields are all required. * The first
|
|
1766
|
+
# label of the monitored resource descriptor must be `resource_container`. There
|
|
1767
|
+
# are legacy monitored resource descritptors start with `project_id`. * It must
|
|
1768
|
+
# include a `location` label. * Maximum of default 5 service defined monitored
|
|
1769
|
+
# resource descriptors is allowed per service. * Maximum of default 10 labels
|
|
1770
|
+
# per monitored resource is allowed. The default maximum limit can be overridden.
|
|
1771
|
+
# Please follow https://cloud.google.com/monitoring/quotas
|
|
2124
1772
|
class MonitoredResourceDescriptor
|
|
2125
1773
|
include Google::Apis::Core::Hashable
|
|
2126
1774
|
|
|
2127
|
-
# Optional. A detailed description of the monitored resource type that might
|
|
2128
|
-
#
|
|
1775
|
+
# Optional. A detailed description of the monitored resource type that might be
|
|
1776
|
+
# used in documentation.
|
|
2129
1777
|
# Corresponds to the JSON property `description`
|
|
2130
1778
|
# @return [String]
|
|
2131
1779
|
attr_accessor :description
|
|
2132
1780
|
|
|
2133
1781
|
# Optional. A concise name for the monitored resource type that might be
|
|
2134
|
-
# displayed in user interfaces. It should be a Title Cased Noun Phrase,
|
|
2135
|
-
#
|
|
2136
|
-
# `"Google Cloud SQL Database"`.
|
|
1782
|
+
# displayed in user interfaces. It should be a Title Cased Noun Phrase, without
|
|
1783
|
+
# any article or other determiners. For example, `"Google Cloud SQL Database"`.
|
|
2137
1784
|
# Corresponds to the JSON property `displayName`
|
|
2138
1785
|
# @return [String]
|
|
2139
1786
|
attr_accessor :display_name
|
|
2140
1787
|
|
|
2141
1788
|
# Required. A set of labels used to describe instances of this monitored
|
|
2142
|
-
# resource type.
|
|
2143
|
-
#
|
|
2144
|
-
# *
|
|
2145
|
-
#
|
|
2146
|
-
#
|
|
2147
|
-
# * The maximum length of a label name is 100 characters.
|
|
2148
|
-
# For example, an individual Google Cloud SQL database is
|
|
2149
|
-
# identified by values for the labels `database_id` and `location`.
|
|
1789
|
+
# resource type. The label key name must follow: * Only upper and lower-case
|
|
1790
|
+
# letters, digits and underscores (_) are allowed. * Label name must start with
|
|
1791
|
+
# a letter or digit. * The maximum length of a label name is 100 characters. For
|
|
1792
|
+
# example, an individual Google Cloud SQL database is identified by values for
|
|
1793
|
+
# the labels `database_id` and `location`.
|
|
2150
1794
|
# Corresponds to the JSON property `labels`
|
|
2151
1795
|
# @return [Array<Google::Apis::ServiceconsumermanagementV1beta1::LabelDescriptor>]
|
|
2152
1796
|
attr_accessor :labels
|
|
@@ -2156,27 +1800,25 @@ module Google
|
|
|
2156
1800
|
# @return [String]
|
|
2157
1801
|
attr_accessor :launch_stage
|
|
2158
1802
|
|
|
2159
|
-
# Optional. The resource name of the monitored resource descriptor:
|
|
2160
|
-
#
|
|
2161
|
-
# `type`
|
|
2162
|
-
#
|
|
2163
|
-
#
|
|
2164
|
-
#
|
|
1803
|
+
# Optional. The resource name of the monitored resource descriptor: `"projects/`
|
|
1804
|
+
# project_id`/monitoredResourceDescriptors/`type`"` where `type` is the value of
|
|
1805
|
+
# the `type` field in this object and `project_id` is a project ID that provides
|
|
1806
|
+
# API-specific context for accessing the type. APIs that do not use project
|
|
1807
|
+
# information can use the resource name format `"monitoredResourceDescriptors/`
|
|
1808
|
+
# type`"`.
|
|
2165
1809
|
# Corresponds to the JSON property `name`
|
|
2166
1810
|
# @return [String]
|
|
2167
1811
|
attr_accessor :name
|
|
2168
1812
|
|
|
2169
|
-
# Required. The monitored resource type. For example, the type
|
|
2170
|
-
#
|
|
2171
|
-
#
|
|
2172
|
-
#
|
|
2173
|
-
#
|
|
2174
|
-
#
|
|
2175
|
-
#
|
|
2176
|
-
#
|
|
2177
|
-
#
|
|
2178
|
-
# is 100.
|
|
2179
|
-
# Note there are legacy service monitored resources not following this rule.
|
|
1813
|
+
# Required. The monitored resource type. For example, the type `
|
|
1814
|
+
# cloudsql_database` represents databases in Google Cloud SQL. All service
|
|
1815
|
+
# defined monitored resource types must be prefixed with the service name, in
|
|
1816
|
+
# the format of ``service name`/`relative resource name``. The relative resource
|
|
1817
|
+
# name must follow: * Only upper and lower-case letters and digits are allowed. *
|
|
1818
|
+
# It must start with upper case character and is recommended to use Upper Camel
|
|
1819
|
+
# Case style. * The maximum number of characters allowed for the
|
|
1820
|
+
# relative_resource_name is 100. Note there are legacy service monitored
|
|
1821
|
+
# resources not following this rule.
|
|
2180
1822
|
# Corresponds to the JSON property `type`
|
|
2181
1823
|
# @return [String]
|
|
2182
1824
|
attr_accessor :type
|
|
@@ -2196,75 +1838,47 @@ module Google
|
|
|
2196
1838
|
end
|
|
2197
1839
|
end
|
|
2198
1840
|
|
|
2199
|
-
# Monitoring configuration of the service.
|
|
2200
|
-
#
|
|
2201
|
-
#
|
|
2202
|
-
#
|
|
2203
|
-
#
|
|
2204
|
-
#
|
|
2205
|
-
#
|
|
2206
|
-
#
|
|
2207
|
-
# -
|
|
2208
|
-
#
|
|
2209
|
-
#
|
|
2210
|
-
#
|
|
2211
|
-
#
|
|
2212
|
-
# - key:
|
|
2213
|
-
#
|
|
2214
|
-
#
|
|
2215
|
-
#
|
|
2216
|
-
#
|
|
2217
|
-
#
|
|
2218
|
-
#
|
|
2219
|
-
#
|
|
2220
|
-
#
|
|
2221
|
-
# description: "The count of books that have been returned."
|
|
2222
|
-
# launch_stage: GA
|
|
2223
|
-
# metric_kind: DELTA
|
|
2224
|
-
# value_type: INT64
|
|
2225
|
-
# unit: "1"
|
|
2226
|
-
# labels:
|
|
2227
|
-
# - key: customer_id
|
|
2228
|
-
# description: "The id of the customer."
|
|
2229
|
-
# - name: library.googleapis.com/book/num_overdue
|
|
2230
|
-
# display_name: "Books Overdue"
|
|
2231
|
-
# description: "The current number of overdue books."
|
|
2232
|
-
# launch_stage: GA
|
|
2233
|
-
# metric_kind: GAUGE
|
|
2234
|
-
# value_type: INT64
|
|
2235
|
-
# unit: "1"
|
|
2236
|
-
# labels:
|
|
2237
|
-
# - key: customer_id
|
|
2238
|
-
# description: "The id of the customer."
|
|
2239
|
-
# monitoring:
|
|
2240
|
-
# producer_destinations:
|
|
2241
|
-
# - monitored_resource: library.googleapis.com/Branch
|
|
2242
|
-
# metrics:
|
|
2243
|
-
# - library.googleapis.com/book/returned_count
|
|
2244
|
-
# consumer_destinations:
|
|
2245
|
-
# - monitored_resource: library.googleapis.com/Branch
|
|
2246
|
-
# metrics:
|
|
2247
|
-
# - library.googleapis.com/book/returned_count
|
|
2248
|
-
# - library.googleapis.com/book/num_overdue
|
|
1841
|
+
# Monitoring configuration of the service. The example below shows how to
|
|
1842
|
+
# configure monitored resources and metrics for monitoring. In the example, a
|
|
1843
|
+
# monitored resource and two metrics are defined. The `library.googleapis.com/
|
|
1844
|
+
# book/returned_count` metric is sent to both producer and consumer projects,
|
|
1845
|
+
# whereas the `library.googleapis.com/book/num_overdue` metric is only sent to
|
|
1846
|
+
# the consumer project. monitored_resources: - type: library.googleapis.com/
|
|
1847
|
+
# Branch display_name: "Library Branch" description: "A branch of a library."
|
|
1848
|
+
# launch_stage: GA labels: - key: resource_container description: "The Cloud
|
|
1849
|
+
# container (ie. project id) for the Branch." - key: location description: "The
|
|
1850
|
+
# location of the library branch." - key: branch_id description: "The id of the
|
|
1851
|
+
# branch." metrics: - name: library.googleapis.com/book/returned_count
|
|
1852
|
+
# display_name: "Books Returned" description: "The count of books that have been
|
|
1853
|
+
# returned." launch_stage: GA metric_kind: DELTA value_type: INT64 unit: "1"
|
|
1854
|
+
# labels: - key: customer_id description: "The id of the customer." - name:
|
|
1855
|
+
# library.googleapis.com/book/num_overdue display_name: "Books Overdue"
|
|
1856
|
+
# description: "The current number of overdue books." launch_stage: GA
|
|
1857
|
+
# metric_kind: GAUGE value_type: INT64 unit: "1" labels: - key: customer_id
|
|
1858
|
+
# description: "The id of the customer." monitoring: producer_destinations: -
|
|
1859
|
+
# monitored_resource: library.googleapis.com/Branch metrics: - library.
|
|
1860
|
+
# googleapis.com/book/returned_count consumer_destinations: - monitored_resource:
|
|
1861
|
+
# library.googleapis.com/Branch metrics: - library.googleapis.com/book/
|
|
1862
|
+
# returned_count - library.googleapis.com/book/num_overdue
|
|
2249
1863
|
class Monitoring
|
|
2250
1864
|
include Google::Apis::Core::Hashable
|
|
2251
1865
|
|
|
2252
|
-
# Monitoring configurations for sending metrics to the consumer project.
|
|
2253
|
-
#
|
|
2254
|
-
#
|
|
2255
|
-
#
|
|
2256
|
-
#
|
|
2257
|
-
#
|
|
1866
|
+
# Monitoring configurations for sending metrics to the consumer project. There
|
|
1867
|
+
# can be multiple consumer destinations. A monitored resource type may appear in
|
|
1868
|
+
# multiple monitoring destinations if different aggregations are needed for
|
|
1869
|
+
# different sets of metrics associated with that monitored resource type. A
|
|
1870
|
+
# monitored resource and metric pair may only be used once in the Monitoring
|
|
1871
|
+
# configuration.
|
|
2258
1872
|
# Corresponds to the JSON property `consumerDestinations`
|
|
2259
1873
|
# @return [Array<Google::Apis::ServiceconsumermanagementV1beta1::MonitoringDestination>]
|
|
2260
1874
|
attr_accessor :consumer_destinations
|
|
2261
1875
|
|
|
2262
|
-
# Monitoring configurations for sending metrics to the producer project.
|
|
2263
|
-
#
|
|
2264
|
-
#
|
|
2265
|
-
#
|
|
2266
|
-
#
|
|
2267
|
-
#
|
|
1876
|
+
# Monitoring configurations for sending metrics to the producer project. There
|
|
1877
|
+
# can be multiple producer destinations. A monitored resource type may appear in
|
|
1878
|
+
# multiple monitoring destinations if different aggregations are needed for
|
|
1879
|
+
# different sets of metrics associated with that monitored resource type. A
|
|
1880
|
+
# monitored resource and metric pair may only be used once in the Monitoring
|
|
1881
|
+
# configuration.
|
|
2268
1882
|
# Corresponds to the JSON property `producerDestinations`
|
|
2269
1883
|
# @return [Array<Google::Apis::ServiceconsumermanagementV1beta1::MonitoringDestination>]
|
|
2270
1884
|
attr_accessor :producer_destinations
|
|
@@ -2280,19 +1894,19 @@ module Google
|
|
|
2280
1894
|
end
|
|
2281
1895
|
end
|
|
2282
1896
|
|
|
2283
|
-
# Configuration of a specific monitoring destination (the producer project
|
|
2284
|
-
#
|
|
1897
|
+
# Configuration of a specific monitoring destination (the producer project or
|
|
1898
|
+
# the consumer project).
|
|
2285
1899
|
class MonitoringDestination
|
|
2286
1900
|
include Google::Apis::Core::Hashable
|
|
2287
1901
|
|
|
2288
|
-
# Types of the metrics to report to this monitoring destination.
|
|
2289
|
-
#
|
|
1902
|
+
# Types of the metrics to report to this monitoring destination. Each type must
|
|
1903
|
+
# be defined in Service.metrics section.
|
|
2290
1904
|
# Corresponds to the JSON property `metrics`
|
|
2291
1905
|
# @return [Array<String>]
|
|
2292
1906
|
attr_accessor :metrics
|
|
2293
1907
|
|
|
2294
|
-
# The monitored resource type. The type must be defined in
|
|
2295
|
-
#
|
|
1908
|
+
# The monitored resource type. The type must be defined in Service.
|
|
1909
|
+
# monitored_resources section.
|
|
2296
1910
|
# Corresponds to the JSON property `monitoredResource`
|
|
2297
1911
|
# @return [String]
|
|
2298
1912
|
attr_accessor :monitored_resource
|
|
@@ -2309,27 +1923,25 @@ module Google
|
|
|
2309
1923
|
end
|
|
2310
1924
|
|
|
2311
1925
|
# OAuth scopes are a way to define data and permissions on data. For example,
|
|
2312
|
-
# there are scopes defined for "Read-only access to Google Calendar" and
|
|
2313
|
-
#
|
|
2314
|
-
#
|
|
2315
|
-
#
|
|
2316
|
-
#
|
|
2317
|
-
#
|
|
2318
|
-
#
|
|
2319
|
-
#
|
|
2320
|
-
#
|
|
2321
|
-
#
|
|
2322
|
-
#
|
|
2323
|
-
#
|
|
2324
|
-
# due to the backend requiring additional scopes or permissions.
|
|
1926
|
+
# there are scopes defined for "Read-only access to Google Calendar" and "Access
|
|
1927
|
+
# to Cloud Platform". Users can consent to a scope for an application, giving it
|
|
1928
|
+
# permission to access that data on their behalf. OAuth scope specifications
|
|
1929
|
+
# should be fairly coarse grained; a user will need to see and understand the
|
|
1930
|
+
# text description of what your scope means. In most cases: use one or at most
|
|
1931
|
+
# two OAuth scopes for an entire family of products. If your product has
|
|
1932
|
+
# multiple APIs, you should probably be sharing the OAuth scope across all of
|
|
1933
|
+
# those APIs. When you need finer grained OAuth consent screens: talk with your
|
|
1934
|
+
# product management about how developers will use them in practice. Please note
|
|
1935
|
+
# that even though each of the canonical scopes is enough for a request to be
|
|
1936
|
+
# accepted and passed to the backend, a request can still fail due to the
|
|
1937
|
+
# backend requiring additional scopes or permissions.
|
|
2325
1938
|
class OAuthRequirements
|
|
2326
1939
|
include Google::Apis::Core::Hashable
|
|
2327
1940
|
|
|
2328
|
-
# The list of publicly documented OAuth scopes that are allowed access. An
|
|
2329
|
-
#
|
|
2330
|
-
#
|
|
2331
|
-
#
|
|
2332
|
-
# https://www.googleapis.com/auth/calendar.read
|
|
1941
|
+
# The list of publicly documented OAuth scopes that are allowed access. An OAuth
|
|
1942
|
+
# token containing any of these scopes will be accepted. Example:
|
|
1943
|
+
# canonical_scopes: https://www.googleapis.com/auth/calendar, https://www.
|
|
1944
|
+
# googleapis.com/auth/calendar.read
|
|
2333
1945
|
# Corresponds to the JSON property `canonicalScopes`
|
|
2334
1946
|
# @return [String]
|
|
2335
1947
|
attr_accessor :canonical_scopes
|
|
@@ -2349,47 +1961,45 @@ module Google
|
|
|
2349
1961
|
class Operation
|
|
2350
1962
|
include Google::Apis::Core::Hashable
|
|
2351
1963
|
|
|
2352
|
-
# If the value is `false`, it means the operation is still in progress.
|
|
2353
|
-
#
|
|
2354
|
-
# available.
|
|
1964
|
+
# If the value is `false`, it means the operation is still in progress. If `true`
|
|
1965
|
+
# , the operation is completed, and either `error` or `response` is available.
|
|
2355
1966
|
# Corresponds to the JSON property `done`
|
|
2356
1967
|
# @return [Boolean]
|
|
2357
1968
|
attr_accessor :done
|
|
2358
1969
|
alias_method :done?, :done
|
|
2359
1970
|
|
|
2360
|
-
# The `Status` type defines a logical error model that is suitable for
|
|
2361
|
-
#
|
|
2362
|
-
#
|
|
2363
|
-
#
|
|
2364
|
-
#
|
|
2365
|
-
#
|
|
1971
|
+
# The `Status` type defines a logical error model that is suitable for different
|
|
1972
|
+
# programming environments, including REST APIs and RPC APIs. It is used by [
|
|
1973
|
+
# gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
|
|
1974
|
+
# data: error code, error message, and error details. You can find out more
|
|
1975
|
+
# about this error model and how to work with it in the [API Design Guide](https:
|
|
1976
|
+
# //cloud.google.com/apis/design/errors).
|
|
2366
1977
|
# Corresponds to the JSON property `error`
|
|
2367
1978
|
# @return [Google::Apis::ServiceconsumermanagementV1beta1::Status]
|
|
2368
1979
|
attr_accessor :error
|
|
2369
1980
|
|
|
2370
|
-
# Service-specific metadata associated with the operation.
|
|
2371
|
-
#
|
|
2372
|
-
#
|
|
2373
|
-
#
|
|
1981
|
+
# Service-specific metadata associated with the operation. It typically contains
|
|
1982
|
+
# progress information and common metadata such as create time. Some services
|
|
1983
|
+
# might not provide such metadata. Any method that returns a long-running
|
|
1984
|
+
# operation should document the metadata type, if any.
|
|
2374
1985
|
# Corresponds to the JSON property `metadata`
|
|
2375
1986
|
# @return [Hash<String,Object>]
|
|
2376
1987
|
attr_accessor :metadata
|
|
2377
1988
|
|
|
2378
1989
|
# The server-assigned name, which is only unique within the same service that
|
|
2379
|
-
# originally returns it. If you use the default HTTP mapping, the
|
|
2380
|
-
#
|
|
1990
|
+
# originally returns it. If you use the default HTTP mapping, the `name` should
|
|
1991
|
+
# be a resource name ending with `operations/`unique_id``.
|
|
2381
1992
|
# Corresponds to the JSON property `name`
|
|
2382
1993
|
# @return [String]
|
|
2383
1994
|
attr_accessor :name
|
|
2384
1995
|
|
|
2385
|
-
# The normal response of the operation in case of success.
|
|
2386
|
-
# method returns no data on success, such as `Delete`, the response is
|
|
2387
|
-
#
|
|
2388
|
-
#
|
|
2389
|
-
#
|
|
2390
|
-
#
|
|
2391
|
-
#
|
|
2392
|
-
# `TakeSnapshotResponse`.
|
|
1996
|
+
# The normal response of the operation in case of success. If the original
|
|
1997
|
+
# method returns no data on success, such as `Delete`, the response is `google.
|
|
1998
|
+
# protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`,
|
|
1999
|
+
# the response should be the resource. For other methods, the response should
|
|
2000
|
+
# have the type `XxxResponse`, where `Xxx` is the original method name. For
|
|
2001
|
+
# example, if the original method name is `TakeSnapshot()`, the inferred
|
|
2002
|
+
# response type is `TakeSnapshotResponse`.
|
|
2393
2003
|
# Corresponds to the JSON property `response`
|
|
2394
2004
|
# @return [Hash<String,Object>]
|
|
2395
2005
|
attr_accessor :response
|
|
@@ -2414,17 +2024,17 @@ module Google
|
|
|
2414
2024
|
include Google::Apis::Core::Hashable
|
|
2415
2025
|
|
|
2416
2026
|
# The option's name. For protobuf built-in options (options defined in
|
|
2417
|
-
# descriptor.proto), this is the short name. For example, `"map_entry"`.
|
|
2418
|
-
#
|
|
2419
|
-
#
|
|
2027
|
+
# descriptor.proto), this is the short name. For example, `"map_entry"`. For
|
|
2028
|
+
# custom options, it should be the fully-qualified name. For example, `"google.
|
|
2029
|
+
# api.http"`.
|
|
2420
2030
|
# Corresponds to the JSON property `name`
|
|
2421
2031
|
# @return [String]
|
|
2422
2032
|
attr_accessor :name
|
|
2423
2033
|
|
|
2424
|
-
# The option's value packed in an Any message. If the value is a primitive,
|
|
2425
|
-
#
|
|
2426
|
-
#
|
|
2427
|
-
#
|
|
2034
|
+
# The option's value packed in an Any message. If the value is a primitive, the
|
|
2035
|
+
# corresponding wrapper type defined in google/protobuf/wrappers.proto should be
|
|
2036
|
+
# used. If the value is an enum, it should be stored as an int32 value using the
|
|
2037
|
+
# google.protobuf.Int32Value type.
|
|
2428
2038
|
# Corresponds to the JSON property `value`
|
|
2429
2039
|
# @return [Hash<String,Object>]
|
|
2430
2040
|
attr_accessor :value
|
|
@@ -2445,32 +2055,25 @@ module Google
|
|
|
2445
2055
|
class Page
|
|
2446
2056
|
include Google::Apis::Core::Hashable
|
|
2447
2057
|
|
|
2448
|
-
# The Markdown content of the page. You can use
|
|
2449
|
-
#
|
|
2058
|
+
# The Markdown content of the page. You can use (== include `path` ==) to
|
|
2059
|
+
# include content from a Markdown file.
|
|
2450
2060
|
# Corresponds to the JSON property `content`
|
|
2451
2061
|
# @return [String]
|
|
2452
2062
|
attr_accessor :content
|
|
2453
2063
|
|
|
2454
|
-
# The name of the page. It will be used as an identity of the page to
|
|
2455
|
-
#
|
|
2456
|
-
#
|
|
2457
|
-
#
|
|
2458
|
-
#
|
|
2459
|
-
#
|
|
2460
|
-
#
|
|
2461
|
-
# content: (== include tutorial.md ==)
|
|
2462
|
-
# subpages:
|
|
2463
|
-
# - name: Java
|
|
2464
|
-
# content: (== include tutorial_java.md ==)
|
|
2465
|
-
# </code></pre>
|
|
2466
|
-
# You can reference `Java` page using Markdown reference link syntax:
|
|
2467
|
-
# `Java`.
|
|
2064
|
+
# The name of the page. It will be used as an identity of the page to generate
|
|
2065
|
+
# URI of the page, text of the link to this page in navigation, etc. The full
|
|
2066
|
+
# page name (start from the root page name to this page concatenated with `.`)
|
|
2067
|
+
# can be used as reference to the page in your documentation. For example: pages:
|
|
2068
|
+
# - name: Tutorial content: (== include tutorial.md ==) subpages: - name: Java
|
|
2069
|
+
# content: (== include tutorial_java.md ==) You can reference `Java` page using
|
|
2070
|
+
# Markdown reference link syntax: `Java`.
|
|
2468
2071
|
# Corresponds to the JSON property `name`
|
|
2469
2072
|
# @return [String]
|
|
2470
2073
|
attr_accessor :name
|
|
2471
2074
|
|
|
2472
|
-
# Subpages of this page. The order of subpages specified here will be
|
|
2473
|
-
#
|
|
2075
|
+
# Subpages of this page. The order of subpages specified here will be honored in
|
|
2076
|
+
# the generated docset.
|
|
2474
2077
|
# Corresponds to the JSON property `subpages`
|
|
2475
2078
|
# @return [Array<Google::Apis::ServiceconsumermanagementV1beta1::Page>]
|
|
2476
2079
|
attr_accessor :subpages
|
|
@@ -2487,46 +2090,25 @@ module Google
|
|
|
2487
2090
|
end
|
|
2488
2091
|
end
|
|
2489
2092
|
|
|
2490
|
-
# Quota configuration helps to achieve fairness and budgeting in service
|
|
2491
|
-
#
|
|
2492
|
-
#
|
|
2493
|
-
#
|
|
2494
|
-
#
|
|
2495
|
-
#
|
|
2496
|
-
#
|
|
2497
|
-
#
|
|
2498
|
-
#
|
|
2499
|
-
#
|
|
2500
|
-
#
|
|
2501
|
-
# -
|
|
2502
|
-
#
|
|
2503
|
-
#
|
|
2504
|
-
#
|
|
2505
|
-
#
|
|
2506
|
-
#
|
|
2507
|
-
#
|
|
2508
|
-
#
|
|
2509
|
-
# # consuming at twice rate as the DeleteBook method.
|
|
2510
|
-
# metric_rules:
|
|
2511
|
-
# - selector: "*"
|
|
2512
|
-
# metric_costs:
|
|
2513
|
-
# library.googleapis.com/read_calls: 1
|
|
2514
|
-
# - selector: google.example.library.v1.LibraryService.UpdateBook
|
|
2515
|
-
# metric_costs:
|
|
2516
|
-
# library.googleapis.com/write_calls: 2
|
|
2517
|
-
# - selector: google.example.library.v1.LibraryService.DeleteBook
|
|
2518
|
-
# metric_costs:
|
|
2519
|
-
# library.googleapis.com/write_calls: 1
|
|
2520
|
-
# Corresponding Metric definition:
|
|
2521
|
-
# metrics:
|
|
2522
|
-
# - name: library.googleapis.com/read_calls
|
|
2523
|
-
# display_name: Read requests
|
|
2524
|
-
# metric_kind: DELTA
|
|
2525
|
-
# value_type: INT64
|
|
2526
|
-
# - name: library.googleapis.com/write_calls
|
|
2527
|
-
# display_name: Write requests
|
|
2528
|
-
# metric_kind: DELTA
|
|
2529
|
-
# value_type: INT64
|
|
2093
|
+
# Quota configuration helps to achieve fairness and budgeting in service usage.
|
|
2094
|
+
# The metric based quota configuration works this way: - The service
|
|
2095
|
+
# configuration defines a set of metrics. - For API calls, the quota.
|
|
2096
|
+
# metric_rules maps methods to metrics with corresponding costs. - The quota.
|
|
2097
|
+
# limits defines limits on the metrics, which will be used for quota checks at
|
|
2098
|
+
# runtime. An example quota configuration in yaml format: quota: limits: - name:
|
|
2099
|
+
# apiWriteQpsPerProject metric: library.googleapis.com/write_calls unit: "1/min/`
|
|
2100
|
+
# project`" # rate limit for consumer projects values: STANDARD: 10000 # The
|
|
2101
|
+
# metric rules bind all methods to the read_calls metric, # except for the
|
|
2102
|
+
# UpdateBook and DeleteBook methods. These two methods # are mapped to the
|
|
2103
|
+
# write_calls metric, with the UpdateBook method # consuming at twice rate as
|
|
2104
|
+
# the DeleteBook method. metric_rules: - selector: "*" metric_costs: library.
|
|
2105
|
+
# googleapis.com/read_calls: 1 - selector: google.example.library.v1.
|
|
2106
|
+
# LibraryService.UpdateBook metric_costs: library.googleapis.com/write_calls: 2 -
|
|
2107
|
+
# selector: google.example.library.v1.LibraryService.DeleteBook metric_costs:
|
|
2108
|
+
# library.googleapis.com/write_calls: 1 Corresponding Metric definition: metrics:
|
|
2109
|
+
# - name: library.googleapis.com/read_calls display_name: Read requests
|
|
2110
|
+
# metric_kind: DELTA value_type: INT64 - name: library.googleapis.com/
|
|
2111
|
+
# write_calls display_name: Write requests metric_kind: DELTA value_type: INT64
|
|
2530
2112
|
class Quota
|
|
2531
2113
|
include Google::Apis::Core::Hashable
|
|
2532
2114
|
|
|
@@ -2535,8 +2117,8 @@ module Google
|
|
|
2535
2117
|
# @return [Array<Google::Apis::ServiceconsumermanagementV1beta1::QuotaLimit>]
|
|
2536
2118
|
attr_accessor :limits
|
|
2537
2119
|
|
|
2538
|
-
# List of `MetricRule` definitions, each one mapping a selected method to one
|
|
2539
|
-
#
|
|
2120
|
+
# List of `MetricRule` definitions, each one mapping a selected method to one or
|
|
2121
|
+
# more metrics.
|
|
2540
2122
|
# Corresponds to the JSON property `metricRules`
|
|
2541
2123
|
# @return [Array<Google::Apis::ServiceconsumermanagementV1beta1::MetricRule>]
|
|
2542
2124
|
attr_accessor :metric_rules
|
|
@@ -2553,95 +2135,89 @@ module Google
|
|
|
2553
2135
|
end
|
|
2554
2136
|
|
|
2555
2137
|
# `QuotaLimit` defines a specific limit that applies over a specified duration
|
|
2556
|
-
# for a limit type. There can be at most one limit for a duration and limit
|
|
2557
|
-
#
|
|
2138
|
+
# for a limit type. There can be at most one limit for a duration and limit type
|
|
2139
|
+
# combination defined within a `QuotaGroup`.
|
|
2558
2140
|
class QuotaLimit
|
|
2559
2141
|
include Google::Apis::Core::Hashable
|
|
2560
2142
|
|
|
2561
|
-
# Default number of tokens that can be consumed during the specified
|
|
2562
|
-
#
|
|
2563
|
-
#
|
|
2564
|
-
#
|
|
2565
|
-
#
|
|
2566
|
-
#
|
|
2567
|
-
#
|
|
2568
|
-
# Used by group-based quotas only.
|
|
2143
|
+
# Default number of tokens that can be consumed during the specified duration.
|
|
2144
|
+
# This is the number of tokens assigned when a client application developer
|
|
2145
|
+
# activates the service for his/her project. Specifying a value of 0 will block
|
|
2146
|
+
# all requests. This can be used if you are provisioning quota to selected
|
|
2147
|
+
# consumers and blocking others. Similarly, a value of -1 will indicate an
|
|
2148
|
+
# unlimited quota. No other negative values are allowed. Used by group-based
|
|
2149
|
+
# quotas only.
|
|
2569
2150
|
# Corresponds to the JSON property `defaultLimit`
|
|
2570
2151
|
# @return [Fixnum]
|
|
2571
2152
|
attr_accessor :default_limit
|
|
2572
2153
|
|
|
2573
|
-
# Optional. User-visible, extended description for this quota limit.
|
|
2574
|
-
#
|
|
2575
|
-
#
|
|
2154
|
+
# Optional. User-visible, extended description for this quota limit. Should be
|
|
2155
|
+
# used only when more context is needed to understand this limit than provided
|
|
2156
|
+
# by the limit's display name (see: `display_name`).
|
|
2576
2157
|
# Corresponds to the JSON property `description`
|
|
2577
2158
|
# @return [String]
|
|
2578
2159
|
attr_accessor :description
|
|
2579
2160
|
|
|
2580
|
-
# User-visible display name for this limit.
|
|
2581
|
-
#
|
|
2582
|
-
#
|
|
2583
|
-
#
|
|
2161
|
+
# User-visible display name for this limit. Optional. If not set, the UI will
|
|
2162
|
+
# provide a default display name based on the quota configuration. This field
|
|
2163
|
+
# can be used to override the default display name generated from the
|
|
2164
|
+
# configuration.
|
|
2584
2165
|
# Corresponds to the JSON property `displayName`
|
|
2585
2166
|
# @return [String]
|
|
2586
2167
|
attr_accessor :display_name
|
|
2587
2168
|
|
|
2588
|
-
# Duration of this limit in textual notation. Must be "100s" or "1d".
|
|
2589
|
-
#
|
|
2169
|
+
# Duration of this limit in textual notation. Must be "100s" or "1d". Used by
|
|
2170
|
+
# group-based quotas only.
|
|
2590
2171
|
# Corresponds to the JSON property `duration`
|
|
2591
2172
|
# @return [String]
|
|
2592
2173
|
attr_accessor :duration
|
|
2593
2174
|
|
|
2594
|
-
# Free tier value displayed in the Developers Console for this limit.
|
|
2595
|
-
#
|
|
2596
|
-
#
|
|
2597
|
-
#
|
|
2598
|
-
#
|
|
2599
|
-
#
|
|
2600
|
-
# Used by group-based quotas only.
|
|
2175
|
+
# Free tier value displayed in the Developers Console for this limit. The free
|
|
2176
|
+
# tier is the number of tokens that will be subtracted from the billed amount
|
|
2177
|
+
# when billing is enabled. This field can only be set on a limit with duration "
|
|
2178
|
+
# 1d", in a billable group; it is invalid on any other limit. If this field is
|
|
2179
|
+
# not set, it defaults to 0, indicating that there is no free tier for this
|
|
2180
|
+
# service. Used by group-based quotas only.
|
|
2601
2181
|
# Corresponds to the JSON property `freeTier`
|
|
2602
2182
|
# @return [Fixnum]
|
|
2603
2183
|
attr_accessor :free_tier
|
|
2604
2184
|
|
|
2605
|
-
# Maximum number of tokens that can be consumed during the specified
|
|
2606
|
-
#
|
|
2607
|
-
#
|
|
2608
|
-
#
|
|
2609
|
-
#
|
|
2610
|
-
#
|
|
2611
|
-
# Used by group-based quotas only.
|
|
2185
|
+
# Maximum number of tokens that can be consumed during the specified duration.
|
|
2186
|
+
# Client application developers can override the default limit up to this
|
|
2187
|
+
# maximum. If specified, this value cannot be set to a value less than the
|
|
2188
|
+
# default limit. If not specified, it is set to the default limit. To allow
|
|
2189
|
+
# clients to apply overrides with no upper bound, set this to -1, indicating
|
|
2190
|
+
# unlimited maximum quota. Used by group-based quotas only.
|
|
2612
2191
|
# Corresponds to the JSON property `maxLimit`
|
|
2613
2192
|
# @return [Fixnum]
|
|
2614
2193
|
attr_accessor :max_limit
|
|
2615
2194
|
|
|
2616
|
-
# The name of the metric this quota limit applies to. The quota limits with
|
|
2617
|
-
#
|
|
2195
|
+
# The name of the metric this quota limit applies to. The quota limits with the
|
|
2196
|
+
# same metric will be checked together during runtime. The metric must be
|
|
2618
2197
|
# defined within the service config.
|
|
2619
2198
|
# Corresponds to the JSON property `metric`
|
|
2620
2199
|
# @return [String]
|
|
2621
2200
|
attr_accessor :metric
|
|
2622
2201
|
|
|
2623
|
-
# Name of the quota limit.
|
|
2624
|
-
#
|
|
2625
|
-
#
|
|
2626
|
-
# The maximum length of the limit name is 64 characters.
|
|
2202
|
+
# Name of the quota limit. The name must be provided, and it must be unique
|
|
2203
|
+
# within the service. The name can only include alphanumeric characters as well
|
|
2204
|
+
# as '-'. The maximum length of the limit name is 64 characters.
|
|
2627
2205
|
# Corresponds to the JSON property `name`
|
|
2628
2206
|
# @return [String]
|
|
2629
2207
|
attr_accessor :name
|
|
2630
2208
|
|
|
2631
|
-
# Specify the unit of the quota limit. It uses the same syntax as
|
|
2632
|
-
#
|
|
2633
|
-
#
|
|
2634
|
-
#
|
|
2635
|
-
#
|
|
2636
|
-
# Note: the order of unit components is insignificant.
|
|
2637
|
-
# The "1" at the beginning is required to follow the metric unit syntax.
|
|
2209
|
+
# Specify the unit of the quota limit. It uses the same syntax as Metric.unit.
|
|
2210
|
+
# The supported unit kinds are determined by the quota backend system. Here are
|
|
2211
|
+
# some examples: * "1/min/`project`" for quota per minute per project. Note: the
|
|
2212
|
+
# order of unit components is insignificant. The "1" at the beginning is
|
|
2213
|
+
# required to follow the metric unit syntax.
|
|
2638
2214
|
# Corresponds to the JSON property `unit`
|
|
2639
2215
|
# @return [String]
|
|
2640
2216
|
attr_accessor :unit
|
|
2641
2217
|
|
|
2642
2218
|
# Tiered limit values. You must specify this as a key:value pair, with an
|
|
2643
|
-
# integer value that is the maximum number of requests allowed for the
|
|
2644
|
-
#
|
|
2219
|
+
# integer value that is the maximum number of requests allowed for the specified
|
|
2220
|
+
# unit. Currently only STANDARD is supported.
|
|
2645
2221
|
# Corresponds to the JSON property `values`
|
|
2646
2222
|
# @return [Hash<String,Fixnum>]
|
|
2647
2223
|
attr_accessor :values
|
|
@@ -2666,50 +2242,32 @@ module Google
|
|
|
2666
2242
|
end
|
|
2667
2243
|
|
|
2668
2244
|
# `Service` is the root object of Google service configuration schema. It
|
|
2669
|
-
# describes basic information about a service, such as the name and the
|
|
2670
|
-
#
|
|
2671
|
-
#
|
|
2672
|
-
#
|
|
2673
|
-
#
|
|
2674
|
-
#
|
|
2675
|
-
#
|
|
2676
|
-
#
|
|
2677
|
-
#
|
|
2678
|
-
# apis:
|
|
2679
|
-
# - name: google.calendar.v3.Calendar
|
|
2680
|
-
# authentication:
|
|
2681
|
-
# providers:
|
|
2682
|
-
# - id: google_calendar_auth
|
|
2683
|
-
# jwks_uri: https://www.googleapis.com/oauth2/v1/certs
|
|
2684
|
-
# issuer: https://securetoken.google.com
|
|
2685
|
-
# rules:
|
|
2686
|
-
# - selector: "*"
|
|
2687
|
-
# requirements:
|
|
2688
|
-
# provider_id: google_calendar_auth
|
|
2245
|
+
# describes basic information about a service, such as the name and the title,
|
|
2246
|
+
# and delegates other aspects to sub-sections. Each sub-section is either a
|
|
2247
|
+
# proto message or a repeated proto message that configures a specific aspect,
|
|
2248
|
+
# such as auth. See each proto message definition for details. Example: type:
|
|
2249
|
+
# google.api.Service config_version: 3 name: calendar.googleapis.com title:
|
|
2250
|
+
# Google Calendar API apis: - name: google.calendar.v3.Calendar authentication:
|
|
2251
|
+
# providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/
|
|
2252
|
+
# oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: "*"
|
|
2253
|
+
# requirements: provider_id: google_calendar_auth
|
|
2689
2254
|
class Service
|
|
2690
2255
|
include Google::Apis::Core::Hashable
|
|
2691
2256
|
|
|
2692
|
-
# A list of API interfaces exported by this service. Only the `name` field
|
|
2693
|
-
#
|
|
2694
|
-
#
|
|
2695
|
-
#
|
|
2696
|
-
#
|
|
2257
|
+
# A list of API interfaces exported by this service. Only the `name` field of
|
|
2258
|
+
# the google.protobuf.Api needs to be provided by the configuration author, as
|
|
2259
|
+
# the remaining fields will be derived from the IDL during the normalization
|
|
2260
|
+
# process. It is an error to specify an API interface here which cannot be
|
|
2261
|
+
# resolved against the associated IDL files.
|
|
2697
2262
|
# Corresponds to the JSON property `apis`
|
|
2698
2263
|
# @return [Array<Google::Apis::ServiceconsumermanagementV1beta1::Api>]
|
|
2699
2264
|
attr_accessor :apis
|
|
2700
2265
|
|
|
2701
|
-
# `Authentication` defines the authentication configuration for an API.
|
|
2702
|
-
#
|
|
2703
|
-
#
|
|
2704
|
-
#
|
|
2705
|
-
#
|
|
2706
|
-
# - id: google_calendar_auth
|
|
2707
|
-
# jwks_uri: https://www.googleapis.com/oauth2/v1/certs
|
|
2708
|
-
# issuer: https://securetoken.google.com
|
|
2709
|
-
# rules:
|
|
2710
|
-
# - selector: "*"
|
|
2711
|
-
# requirements:
|
|
2712
|
-
# provider_id: google_calendar_auth
|
|
2266
|
+
# `Authentication` defines the authentication configuration for an API. Example
|
|
2267
|
+
# for an API targeted for external use: name: calendar.googleapis.com
|
|
2268
|
+
# authentication: providers: - id: google_calendar_auth jwks_uri: https://www.
|
|
2269
|
+
# googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: -
|
|
2270
|
+
# selector: "*" requirements: provider_id: google_calendar_auth
|
|
2713
2271
|
# Corresponds to the JSON property `authentication`
|
|
2714
2272
|
# @return [Google::Apis::ServiceconsumermanagementV1beta1::Authentication]
|
|
2715
2273
|
attr_accessor :authentication
|
|
@@ -2719,211 +2277,136 @@ module Google
|
|
|
2719
2277
|
# @return [Google::Apis::ServiceconsumermanagementV1beta1::Backend]
|
|
2720
2278
|
attr_accessor :backend
|
|
2721
2279
|
|
|
2722
|
-
# Billing related configuration of the service.
|
|
2723
|
-
#
|
|
2724
|
-
#
|
|
2725
|
-
#
|
|
2726
|
-
#
|
|
2727
|
-
#
|
|
2728
|
-
#
|
|
2729
|
-
#
|
|
2730
|
-
# -
|
|
2731
|
-
#
|
|
2732
|
-
# - key:
|
|
2733
|
-
#
|
|
2734
|
-
#
|
|
2735
|
-
# -
|
|
2736
|
-
#
|
|
2737
|
-
# Custom label to define the city where the library branch is located
|
|
2738
|
-
# in.
|
|
2739
|
-
# - key: name
|
|
2740
|
-
# description: Custom label to define the name of the library branch.
|
|
2741
|
-
# metrics:
|
|
2742
|
-
# - name: library.googleapis.com/book/borrowed_count
|
|
2743
|
-
# metric_kind: DELTA
|
|
2744
|
-
# value_type: INT64
|
|
2745
|
-
# unit: "1"
|
|
2746
|
-
# billing:
|
|
2747
|
-
# consumer_destinations:
|
|
2748
|
-
# - monitored_resource: library.googleapis.com/billing_branch
|
|
2749
|
-
# metrics:
|
|
2750
|
-
# - library.googleapis.com/book/borrowed_count
|
|
2280
|
+
# Billing related configuration of the service. The following example shows how
|
|
2281
|
+
# to configure monitored resources and metrics for billing, `
|
|
2282
|
+
# consumer_destinations` is the only supported destination and the monitored
|
|
2283
|
+
# resources need at least one label key `cloud.googleapis.com/location` to
|
|
2284
|
+
# indicate the location of the billing usage, using different monitored
|
|
2285
|
+
# resources between monitoring and billing is recommended so they can be evolved
|
|
2286
|
+
# independently: monitored_resources: - type: library.googleapis.com/
|
|
2287
|
+
# billing_branch labels: - key: cloud.googleapis.com/location description: |
|
|
2288
|
+
# Predefined label to support billing location restriction. - key: city
|
|
2289
|
+
# description: | Custom label to define the city where the library branch is
|
|
2290
|
+
# located in. - key: name description: Custom label to define the name of the
|
|
2291
|
+
# library branch. metrics: - name: library.googleapis.com/book/borrowed_count
|
|
2292
|
+
# metric_kind: DELTA value_type: INT64 unit: "1" billing: consumer_destinations:
|
|
2293
|
+
# - monitored_resource: library.googleapis.com/billing_branch metrics: - library.
|
|
2294
|
+
# googleapis.com/book/borrowed_count
|
|
2751
2295
|
# Corresponds to the JSON property `billing`
|
|
2752
2296
|
# @return [Google::Apis::ServiceconsumermanagementV1beta1::Billing]
|
|
2753
2297
|
attr_accessor :billing
|
|
2754
2298
|
|
|
2755
|
-
# The semantic version of the service configuration. The config version
|
|
2756
|
-
#
|
|
2757
|
-
#
|
|
2758
|
-
#
|
|
2299
|
+
# The semantic version of the service configuration. The config version affects
|
|
2300
|
+
# the interpretation of the service configuration. For example, certain features
|
|
2301
|
+
# are enabled by default for certain config versions. The latest config version
|
|
2302
|
+
# is `3`.
|
|
2759
2303
|
# Corresponds to the JSON property `configVersion`
|
|
2760
2304
|
# @return [Fixnum]
|
|
2761
2305
|
attr_accessor :config_version
|
|
2762
2306
|
|
|
2763
|
-
# `Context` defines which contexts an API requests.
|
|
2764
|
-
#
|
|
2765
|
-
# context
|
|
2766
|
-
#
|
|
2767
|
-
#
|
|
2768
|
-
#
|
|
2769
|
-
# -
|
|
2770
|
-
#
|
|
2771
|
-
#
|
|
2772
|
-
#
|
|
2773
|
-
#
|
|
2774
|
-
#
|
|
2775
|
-
#
|
|
2776
|
-
# This also provides mechanism to whitelist any protobuf message extension that
|
|
2777
|
-
# can be sent in grpc metadata using “x-goog-ext-<extension_id>-bin” and
|
|
2778
|
-
# “x-goog-ext-<extension_id>-jspb” format. For example, list any service
|
|
2779
|
-
# specific protobuf types that can appear in grpc metadata as follows in your
|
|
2780
|
-
# yaml file:
|
|
2781
|
-
# Example:
|
|
2782
|
-
# context:
|
|
2783
|
-
# rules:
|
|
2784
|
-
# - selector: "google.example.library.v1.LibraryService.CreateBook"
|
|
2785
|
-
# allowed_request_extensions:
|
|
2786
|
-
# - google.foo.v1.NewExtension
|
|
2787
|
-
# allowed_response_extensions:
|
|
2788
|
-
# - google.foo.v1.NewExtension
|
|
2789
|
-
# You can also specify extension ID instead of fully qualified extension name
|
|
2790
|
-
# here.
|
|
2307
|
+
# `Context` defines which contexts an API requests. Example: context: rules: -
|
|
2308
|
+
# selector: "*" requested: - google.rpc.context.ProjectContext - google.rpc.
|
|
2309
|
+
# context.OriginContext The above specifies that all methods in the API request `
|
|
2310
|
+
# google.rpc.context.ProjectContext` and `google.rpc.context.OriginContext`.
|
|
2311
|
+
# Available context types are defined in package `google.rpc.context`. This also
|
|
2312
|
+
# provides mechanism to whitelist any protobuf message extension that can be
|
|
2313
|
+
# sent in grpc metadata using “x-goog-ext--bin” and “x-goog-ext--jspb” format.
|
|
2314
|
+
# For example, list any service specific protobuf types that can appear in grpc
|
|
2315
|
+
# metadata as follows in your yaml file: Example: context: rules: - selector: "
|
|
2316
|
+
# google.example.library.v1.LibraryService.CreateBook"
|
|
2317
|
+
# allowed_request_extensions: - google.foo.v1.NewExtension
|
|
2318
|
+
# allowed_response_extensions: - google.foo.v1.NewExtension You can also specify
|
|
2319
|
+
# extension ID instead of fully qualified extension name here.
|
|
2791
2320
|
# Corresponds to the JSON property `context`
|
|
2792
2321
|
# @return [Google::Apis::ServiceconsumermanagementV1beta1::Context]
|
|
2793
2322
|
attr_accessor :context
|
|
2794
2323
|
|
|
2795
|
-
# Selects and configures the service controller used by the service.
|
|
2796
|
-
#
|
|
2797
|
-
#
|
|
2324
|
+
# Selects and configures the service controller used by the service. The service
|
|
2325
|
+
# controller handles features like abuse, quota, billing, logging, monitoring,
|
|
2326
|
+
# etc.
|
|
2798
2327
|
# Corresponds to the JSON property `control`
|
|
2799
2328
|
# @return [Google::Apis::ServiceconsumermanagementV1beta1::Control]
|
|
2800
2329
|
attr_accessor :control
|
|
2801
2330
|
|
|
2802
|
-
# Customize service error responses.
|
|
2803
|
-
#
|
|
2804
|
-
#
|
|
2805
|
-
#
|
|
2806
|
-
# custom_error:
|
|
2807
|
-
# types:
|
|
2808
|
-
# - google.foo.v1.CustomError
|
|
2809
|
-
# - google.foo.v1.AnotherError
|
|
2331
|
+
# Customize service error responses. For example, list any service specific
|
|
2332
|
+
# protobuf types that can appear in error detail lists of error responses.
|
|
2333
|
+
# Example: custom_error: types: - google.foo.v1.CustomError - google.foo.v1.
|
|
2334
|
+
# AnotherError
|
|
2810
2335
|
# Corresponds to the JSON property `customError`
|
|
2811
2336
|
# @return [Google::Apis::ServiceconsumermanagementV1beta1::CustomError]
|
|
2812
2337
|
attr_accessor :custom_error
|
|
2813
2338
|
|
|
2814
|
-
# `Documentation` provides the information for describing a service.
|
|
2815
|
-
#
|
|
2816
|
-
#
|
|
2817
|
-
#
|
|
2818
|
-
#
|
|
2819
|
-
#
|
|
2820
|
-
#
|
|
2821
|
-
#
|
|
2822
|
-
#
|
|
2823
|
-
#
|
|
2824
|
-
#
|
|
2825
|
-
#
|
|
2826
|
-
#
|
|
2827
|
-
#
|
|
2828
|
-
#
|
|
2829
|
-
#
|
|
2830
|
-
#
|
|
2831
|
-
#
|
|
2832
|
-
#
|
|
2833
|
-
#
|
|
2834
|
-
#
|
|
2835
|
-
#
|
|
2836
|
-
#
|
|
2837
|
-
#
|
|
2838
|
-
#
|
|
2839
|
-
#
|
|
2840
|
-
# a documentation fragment is embedded.
|
|
2841
|
-
# Documentation from the IDL is merged with documentation defined
|
|
2842
|
-
# via the config at normalization time, where documentation provided
|
|
2843
|
-
# by config rules overrides IDL provided.
|
|
2844
|
-
# A number of constructs specific to the API platform are supported
|
|
2845
|
-
# in documentation text.
|
|
2846
|
-
# In order to reference a proto element, the following
|
|
2847
|
-
# notation can be used:
|
|
2848
|
-
# <pre><code>[fully.qualified.proto.name][]</code></pre>
|
|
2849
|
-
# To override the display text used for the link, this can be used:
|
|
2850
|
-
# <pre><code>[display text][fully.qualified.proto.name]</code></pre>
|
|
2851
|
-
# Text can be excluded from doc using the following notation:
|
|
2852
|
-
# <pre><code>(-- internal comment --)</code></pre>
|
|
2853
|
-
# A few directives are available in documentation. Note that
|
|
2854
|
-
# directives must appear on a single line to be properly
|
|
2855
|
-
# identified. The `include` directive includes a markdown file from
|
|
2856
|
-
# an external source:
|
|
2857
|
-
# <pre><code>(== include path/to/file ==)</code></pre>
|
|
2858
|
-
# The `resource_for` directive marks a message to be the resource of
|
|
2859
|
-
# a collection in REST view. If it is not specified, tools attempt
|
|
2860
|
-
# to infer the resource from the operations in a collection:
|
|
2861
|
-
# <pre><code>(== resource_for v1.shelves.books ==)</code></pre>
|
|
2862
|
-
# The directive `suppress_warning` does not directly affect documentation
|
|
2863
|
-
# and is documented together with service config validation.
|
|
2339
|
+
# `Documentation` provides the information for describing a service. Example:
|
|
2340
|
+
# documentation: summary: > The Google Calendar API gives access to most
|
|
2341
|
+
# calendar features. pages: - name: Overview content: (== include google/foo/
|
|
2342
|
+
# overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==
|
|
2343
|
+
# ) subpages; - name: Java content: (== include google/foo/tutorial_java.md ==)
|
|
2344
|
+
# rules: - selector: google.calendar.Calendar.Get description: > ... - selector:
|
|
2345
|
+
# google.calendar.Calendar.Put description: > ... Documentation is provided in
|
|
2346
|
+
# markdown syntax. In addition to standard markdown features, definition lists,
|
|
2347
|
+
# tables and fenced code blocks are supported. Section headers can be provided
|
|
2348
|
+
# and are interpreted relative to the section nesting of the context where a
|
|
2349
|
+
# documentation fragment is embedded. Documentation from the IDL is merged with
|
|
2350
|
+
# documentation defined via the config at normalization time, where
|
|
2351
|
+
# documentation provided by config rules overrides IDL provided. A number of
|
|
2352
|
+
# constructs specific to the API platform are supported in documentation text.
|
|
2353
|
+
# In order to reference a proto element, the following notation can be used: [
|
|
2354
|
+
# fully.qualified.proto.name][] To override the display text used for the link,
|
|
2355
|
+
# this can be used: [display text][fully.qualified.proto.name] Text can be
|
|
2356
|
+
# excluded from doc using the following notation: (-- internal comment --) A few
|
|
2357
|
+
# directives are available in documentation. Note that directives must appear on
|
|
2358
|
+
# a single line to be properly identified. The `include` directive includes a
|
|
2359
|
+
# markdown file from an external source: (== include path/to/file ==) The `
|
|
2360
|
+
# resource_for` directive marks a message to be the resource of a collection in
|
|
2361
|
+
# REST view. If it is not specified, tools attempt to infer the resource from
|
|
2362
|
+
# the operations in a collection: (== resource_for v1.shelves.books ==) The
|
|
2363
|
+
# directive `suppress_warning` does not directly affect documentation and is
|
|
2364
|
+
# documented together with service config validation.
|
|
2864
2365
|
# Corresponds to the JSON property `documentation`
|
|
2865
2366
|
# @return [Google::Apis::ServiceconsumermanagementV1beta1::Documentation]
|
|
2866
2367
|
attr_accessor :documentation
|
|
2867
2368
|
|
|
2868
|
-
# Configuration for network endpoints.
|
|
2869
|
-
#
|
|
2870
|
-
#
|
|
2369
|
+
# Configuration for network endpoints. If this is empty, then an endpoint with
|
|
2370
|
+
# the same name as the service is automatically generated to service all defined
|
|
2371
|
+
# APIs.
|
|
2871
2372
|
# Corresponds to the JSON property `endpoints`
|
|
2872
2373
|
# @return [Array<Google::Apis::ServiceconsumermanagementV1beta1::Endpoint>]
|
|
2873
2374
|
attr_accessor :endpoints
|
|
2874
2375
|
|
|
2875
|
-
# A list of all enum types included in this API service.
|
|
2876
|
-
#
|
|
2877
|
-
#
|
|
2878
|
-
#
|
|
2879
|
-
# enums:
|
|
2880
|
-
# - name: google.someapi.v1.SomeEnum
|
|
2376
|
+
# A list of all enum types included in this API service. Enums referenced
|
|
2377
|
+
# directly or indirectly by the `apis` are automatically included. Enums which
|
|
2378
|
+
# are not referenced but shall be included should be listed here by name.
|
|
2379
|
+
# Example: enums: - name: google.someapi.v1.SomeEnum
|
|
2881
2380
|
# Corresponds to the JSON property `enums`
|
|
2882
2381
|
# @return [Array<Google::Apis::ServiceconsumermanagementV1beta1::Enum>]
|
|
2883
2382
|
attr_accessor :enums
|
|
2884
2383
|
|
|
2885
2384
|
# Defines the HTTP configuration for an API service. It contains a list of
|
|
2886
|
-
# HttpRule, each specifying the mapping of an RPC method
|
|
2887
|
-
#
|
|
2385
|
+
# HttpRule, each specifying the mapping of an RPC method to one or more HTTP
|
|
2386
|
+
# REST API methods.
|
|
2888
2387
|
# Corresponds to the JSON property `http`
|
|
2889
2388
|
# @return [Google::Apis::ServiceconsumermanagementV1beta1::Http]
|
|
2890
2389
|
attr_accessor :http
|
|
2891
2390
|
|
|
2892
|
-
# A unique ID for a specific instance of this message, typically assigned
|
|
2893
|
-
#
|
|
2894
|
-
#
|
|
2895
|
-
#
|
|
2391
|
+
# A unique ID for a specific instance of this message, typically assigned by the
|
|
2392
|
+
# client for tracking purpose. Must be no longer than 63 characters and only
|
|
2393
|
+
# lower case letters, digits, '.', '_' and '-' are allowed. If empty, the server
|
|
2394
|
+
# may choose to generate one instead.
|
|
2896
2395
|
# Corresponds to the JSON property `id`
|
|
2897
2396
|
# @return [String]
|
|
2898
2397
|
attr_accessor :id
|
|
2899
2398
|
|
|
2900
|
-
# Logging configuration of the service.
|
|
2901
|
-
#
|
|
2902
|
-
#
|
|
2903
|
-
# log is sent to
|
|
2904
|
-
#
|
|
2905
|
-
#
|
|
2906
|
-
# -
|
|
2907
|
-
# labels:
|
|
2908
|
-
# -
|
|
2909
|
-
#
|
|
2910
|
-
#
|
|
2911
|
-
# description: The name of the branch.
|
|
2912
|
-
# logs:
|
|
2913
|
-
# - name: activity_history
|
|
2914
|
-
# labels:
|
|
2915
|
-
# - key: /customer_id
|
|
2916
|
-
# - name: purchase_history
|
|
2917
|
-
# logging:
|
|
2918
|
-
# producer_destinations:
|
|
2919
|
-
# - monitored_resource: library.googleapis.com/branch
|
|
2920
|
-
# logs:
|
|
2921
|
-
# - activity_history
|
|
2922
|
-
# - purchase_history
|
|
2923
|
-
# consumer_destinations:
|
|
2924
|
-
# - monitored_resource: library.googleapis.com/branch
|
|
2925
|
-
# logs:
|
|
2926
|
-
# - activity_history
|
|
2399
|
+
# Logging configuration of the service. The following example shows how to
|
|
2400
|
+
# configure logs to be sent to the producer and consumer projects. In the
|
|
2401
|
+
# example, the `activity_history` log is sent to both the producer and consumer
|
|
2402
|
+
# projects, whereas the `purchase_history` log is only sent to the producer
|
|
2403
|
+
# project. monitored_resources: - type: library.googleapis.com/branch labels: -
|
|
2404
|
+
# key: /city description: The city where the library branch is located in. - key:
|
|
2405
|
+
# /name description: The name of the branch. logs: - name: activity_history
|
|
2406
|
+
# labels: - key: /customer_id - name: purchase_history logging:
|
|
2407
|
+
# producer_destinations: - monitored_resource: library.googleapis.com/branch
|
|
2408
|
+
# logs: - activity_history - purchase_history consumer_destinations: -
|
|
2409
|
+
# monitored_resource: library.googleapis.com/branch logs: - activity_history
|
|
2927
2410
|
# Corresponds to the JSON property `logging`
|
|
2928
2411
|
# @return [Google::Apis::ServiceconsumermanagementV1beta1::Logging]
|
|
2929
2412
|
attr_accessor :logging
|
|
@@ -2938,70 +2421,41 @@ module Google
|
|
|
2938
2421
|
# @return [Array<Google::Apis::ServiceconsumermanagementV1beta1::MetricDescriptor>]
|
|
2939
2422
|
attr_accessor :metrics
|
|
2940
2423
|
|
|
2941
|
-
# Defines the monitored resources used by this service. This is required
|
|
2942
|
-
#
|
|
2424
|
+
# Defines the monitored resources used by this service. This is required by the
|
|
2425
|
+
# Service.monitoring and Service.logging configurations.
|
|
2943
2426
|
# Corresponds to the JSON property `monitoredResources`
|
|
2944
2427
|
# @return [Array<Google::Apis::ServiceconsumermanagementV1beta1::MonitoredResourceDescriptor>]
|
|
2945
2428
|
attr_accessor :monitored_resources
|
|
2946
2429
|
|
|
2947
|
-
# Monitoring configuration of the service.
|
|
2948
|
-
#
|
|
2949
|
-
#
|
|
2950
|
-
#
|
|
2951
|
-
#
|
|
2952
|
-
#
|
|
2953
|
-
#
|
|
2954
|
-
#
|
|
2955
|
-
# -
|
|
2956
|
-
#
|
|
2957
|
-
#
|
|
2958
|
-
#
|
|
2959
|
-
#
|
|
2960
|
-
# - key:
|
|
2961
|
-
#
|
|
2962
|
-
#
|
|
2963
|
-
#
|
|
2964
|
-
#
|
|
2965
|
-
#
|
|
2966
|
-
#
|
|
2967
|
-
#
|
|
2968
|
-
#
|
|
2969
|
-
# description: "The count of books that have been returned."
|
|
2970
|
-
# launch_stage: GA
|
|
2971
|
-
# metric_kind: DELTA
|
|
2972
|
-
# value_type: INT64
|
|
2973
|
-
# unit: "1"
|
|
2974
|
-
# labels:
|
|
2975
|
-
# - key: customer_id
|
|
2976
|
-
# description: "The id of the customer."
|
|
2977
|
-
# - name: library.googleapis.com/book/num_overdue
|
|
2978
|
-
# display_name: "Books Overdue"
|
|
2979
|
-
# description: "The current number of overdue books."
|
|
2980
|
-
# launch_stage: GA
|
|
2981
|
-
# metric_kind: GAUGE
|
|
2982
|
-
# value_type: INT64
|
|
2983
|
-
# unit: "1"
|
|
2984
|
-
# labels:
|
|
2985
|
-
# - key: customer_id
|
|
2986
|
-
# description: "The id of the customer."
|
|
2987
|
-
# monitoring:
|
|
2988
|
-
# producer_destinations:
|
|
2989
|
-
# - monitored_resource: library.googleapis.com/Branch
|
|
2990
|
-
# metrics:
|
|
2991
|
-
# - library.googleapis.com/book/returned_count
|
|
2992
|
-
# consumer_destinations:
|
|
2993
|
-
# - monitored_resource: library.googleapis.com/Branch
|
|
2994
|
-
# metrics:
|
|
2995
|
-
# - library.googleapis.com/book/returned_count
|
|
2996
|
-
# - library.googleapis.com/book/num_overdue
|
|
2430
|
+
# Monitoring configuration of the service. The example below shows how to
|
|
2431
|
+
# configure monitored resources and metrics for monitoring. In the example, a
|
|
2432
|
+
# monitored resource and two metrics are defined. The `library.googleapis.com/
|
|
2433
|
+
# book/returned_count` metric is sent to both producer and consumer projects,
|
|
2434
|
+
# whereas the `library.googleapis.com/book/num_overdue` metric is only sent to
|
|
2435
|
+
# the consumer project. monitored_resources: - type: library.googleapis.com/
|
|
2436
|
+
# Branch display_name: "Library Branch" description: "A branch of a library."
|
|
2437
|
+
# launch_stage: GA labels: - key: resource_container description: "The Cloud
|
|
2438
|
+
# container (ie. project id) for the Branch." - key: location description: "The
|
|
2439
|
+
# location of the library branch." - key: branch_id description: "The id of the
|
|
2440
|
+
# branch." metrics: - name: library.googleapis.com/book/returned_count
|
|
2441
|
+
# display_name: "Books Returned" description: "The count of books that have been
|
|
2442
|
+
# returned." launch_stage: GA metric_kind: DELTA value_type: INT64 unit: "1"
|
|
2443
|
+
# labels: - key: customer_id description: "The id of the customer." - name:
|
|
2444
|
+
# library.googleapis.com/book/num_overdue display_name: "Books Overdue"
|
|
2445
|
+
# description: "The current number of overdue books." launch_stage: GA
|
|
2446
|
+
# metric_kind: GAUGE value_type: INT64 unit: "1" labels: - key: customer_id
|
|
2447
|
+
# description: "The id of the customer." monitoring: producer_destinations: -
|
|
2448
|
+
# monitored_resource: library.googleapis.com/Branch metrics: - library.
|
|
2449
|
+
# googleapis.com/book/returned_count consumer_destinations: - monitored_resource:
|
|
2450
|
+
# library.googleapis.com/Branch metrics: - library.googleapis.com/book/
|
|
2451
|
+
# returned_count - library.googleapis.com/book/num_overdue
|
|
2997
2452
|
# Corresponds to the JSON property `monitoring`
|
|
2998
2453
|
# @return [Google::Apis::ServiceconsumermanagementV1beta1::Monitoring]
|
|
2999
2454
|
attr_accessor :monitoring
|
|
3000
2455
|
|
|
3001
|
-
# The service name, which is a DNS-like logical identifier for the
|
|
3002
|
-
#
|
|
3003
|
-
#
|
|
3004
|
-
# of the service also owns the DNS name.
|
|
2456
|
+
# The service name, which is a DNS-like logical identifier for the service, such
|
|
2457
|
+
# as `calendar.googleapis.com`. The service name typically goes through DNS
|
|
2458
|
+
# verification to make sure the owner of the service also owns the DNS name.
|
|
3005
2459
|
# Corresponds to the JSON property `name`
|
|
3006
2460
|
# @return [String]
|
|
3007
2461
|
attr_accessor :name
|
|
@@ -3011,46 +2465,25 @@ module Google
|
|
|
3011
2465
|
# @return [String]
|
|
3012
2466
|
attr_accessor :producer_project_id
|
|
3013
2467
|
|
|
3014
|
-
# Quota configuration helps to achieve fairness and budgeting in service
|
|
3015
|
-
#
|
|
3016
|
-
#
|
|
3017
|
-
#
|
|
3018
|
-
#
|
|
3019
|
-
#
|
|
3020
|
-
#
|
|
3021
|
-
#
|
|
3022
|
-
#
|
|
3023
|
-
#
|
|
3024
|
-
#
|
|
3025
|
-
# -
|
|
3026
|
-
#
|
|
3027
|
-
#
|
|
3028
|
-
#
|
|
3029
|
-
#
|
|
3030
|
-
#
|
|
3031
|
-
#
|
|
3032
|
-
#
|
|
3033
|
-
# # consuming at twice rate as the DeleteBook method.
|
|
3034
|
-
# metric_rules:
|
|
3035
|
-
# - selector: "*"
|
|
3036
|
-
# metric_costs:
|
|
3037
|
-
# library.googleapis.com/read_calls: 1
|
|
3038
|
-
# - selector: google.example.library.v1.LibraryService.UpdateBook
|
|
3039
|
-
# metric_costs:
|
|
3040
|
-
# library.googleapis.com/write_calls: 2
|
|
3041
|
-
# - selector: google.example.library.v1.LibraryService.DeleteBook
|
|
3042
|
-
# metric_costs:
|
|
3043
|
-
# library.googleapis.com/write_calls: 1
|
|
3044
|
-
# Corresponding Metric definition:
|
|
3045
|
-
# metrics:
|
|
3046
|
-
# - name: library.googleapis.com/read_calls
|
|
3047
|
-
# display_name: Read requests
|
|
3048
|
-
# metric_kind: DELTA
|
|
3049
|
-
# value_type: INT64
|
|
3050
|
-
# - name: library.googleapis.com/write_calls
|
|
3051
|
-
# display_name: Write requests
|
|
3052
|
-
# metric_kind: DELTA
|
|
3053
|
-
# value_type: INT64
|
|
2468
|
+
# Quota configuration helps to achieve fairness and budgeting in service usage.
|
|
2469
|
+
# The metric based quota configuration works this way: - The service
|
|
2470
|
+
# configuration defines a set of metrics. - For API calls, the quota.
|
|
2471
|
+
# metric_rules maps methods to metrics with corresponding costs. - The quota.
|
|
2472
|
+
# limits defines limits on the metrics, which will be used for quota checks at
|
|
2473
|
+
# runtime. An example quota configuration in yaml format: quota: limits: - name:
|
|
2474
|
+
# apiWriteQpsPerProject metric: library.googleapis.com/write_calls unit: "1/min/`
|
|
2475
|
+
# project`" # rate limit for consumer projects values: STANDARD: 10000 # The
|
|
2476
|
+
# metric rules bind all methods to the read_calls metric, # except for the
|
|
2477
|
+
# UpdateBook and DeleteBook methods. These two methods # are mapped to the
|
|
2478
|
+
# write_calls metric, with the UpdateBook method # consuming at twice rate as
|
|
2479
|
+
# the DeleteBook method. metric_rules: - selector: "*" metric_costs: library.
|
|
2480
|
+
# googleapis.com/read_calls: 1 - selector: google.example.library.v1.
|
|
2481
|
+
# LibraryService.UpdateBook metric_costs: library.googleapis.com/write_calls: 2 -
|
|
2482
|
+
# selector: google.example.library.v1.LibraryService.DeleteBook metric_costs:
|
|
2483
|
+
# library.googleapis.com/write_calls: 1 Corresponding Metric definition: metrics:
|
|
2484
|
+
# - name: library.googleapis.com/read_calls display_name: Read requests
|
|
2485
|
+
# metric_kind: DELTA value_type: INT64 - name: library.googleapis.com/
|
|
2486
|
+
# write_calls display_name: Write requests metric_kind: DELTA value_type: INT64
|
|
3054
2487
|
# Corresponds to the JSON property `quota`
|
|
3055
2488
|
# @return [Google::Apis::ServiceconsumermanagementV1beta1::Quota]
|
|
3056
2489
|
attr_accessor :quota
|
|
@@ -3060,20 +2493,18 @@ module Google
|
|
|
3060
2493
|
# @return [Google::Apis::ServiceconsumermanagementV1beta1::SourceInfo]
|
|
3061
2494
|
attr_accessor :source_info
|
|
3062
2495
|
|
|
3063
|
-
# ### System parameter configuration
|
|
3064
|
-
#
|
|
3065
|
-
#
|
|
3066
|
-
#
|
|
3067
|
-
# change the names of the system parameters.
|
|
2496
|
+
# ### System parameter configuration A system parameter is a special kind of
|
|
2497
|
+
# parameter defined by the API system, not by an individual API. It is typically
|
|
2498
|
+
# mapped to an HTTP header and/or a URL query parameter. This configuration
|
|
2499
|
+
# specifies which methods change the names of the system parameters.
|
|
3068
2500
|
# Corresponds to the JSON property `systemParameters`
|
|
3069
2501
|
# @return [Google::Apis::ServiceconsumermanagementV1beta1::SystemParameters]
|
|
3070
2502
|
attr_accessor :system_parameters
|
|
3071
2503
|
|
|
3072
|
-
# A list of all proto message types included in this API service.
|
|
3073
|
-
#
|
|
3074
|
-
#
|
|
3075
|
-
#
|
|
3076
|
-
# to define system APIs in ESF.
|
|
2504
|
+
# A list of all proto message types included in this API service. It serves
|
|
2505
|
+
# similar purpose as [google.api.Service.types], except that these types are not
|
|
2506
|
+
# needed by user-defined APIs. Therefore, they will not show up in the generated
|
|
2507
|
+
# discovery doc. This field should only be used to define system APIs in ESF.
|
|
3077
2508
|
# Corresponds to the JSON property `systemTypes`
|
|
3078
2509
|
# @return [Array<Google::Apis::ServiceconsumermanagementV1beta1::Type>]
|
|
3079
2510
|
attr_accessor :system_types
|
|
@@ -3083,12 +2514,10 @@ module Google
|
|
|
3083
2514
|
# @return [String]
|
|
3084
2515
|
attr_accessor :title
|
|
3085
2516
|
|
|
3086
|
-
# A list of all proto message types included in this API service.
|
|
3087
|
-
#
|
|
3088
|
-
#
|
|
3089
|
-
#
|
|
3090
|
-
# should be listed here by name. Example:
|
|
3091
|
-
# types:
|
|
2517
|
+
# A list of all proto message types included in this API service. Types
|
|
2518
|
+
# referenced directly or indirectly by the `apis` are automatically included.
|
|
2519
|
+
# Messages which are not referenced but shall be included, such as types used by
|
|
2520
|
+
# the `google.protobuf.Any` type, should be listed here by name. Example: types:
|
|
3092
2521
|
# - name: google.protobuf.Int32
|
|
3093
2522
|
# Corresponds to the JSON property `types`
|
|
3094
2523
|
# @return [Array<Google::Apis::ServiceconsumermanagementV1beta1::Type>]
|
|
@@ -3135,32 +2564,28 @@ module Google
|
|
|
3135
2564
|
end
|
|
3136
2565
|
end
|
|
3137
2566
|
|
|
3138
|
-
# The per-product per-project service identity for a service.
|
|
3139
|
-
#
|
|
3140
|
-
#
|
|
3141
|
-
#
|
|
3142
|
-
#
|
|
3143
|
-
# - service_account_parent: "projects/123456789"
|
|
3144
|
-
# display_name: "Cloud XXX Service Agent"
|
|
3145
|
-
# description: "Used as the identity of Cloud XXX to access resources"
|
|
2567
|
+
# The per-product per-project service identity for a service. Use this field to
|
|
2568
|
+
# configure per-product per-project service identity. Example of a service
|
|
2569
|
+
# identity configuration. usage: service_identity: - service_account_parent: "
|
|
2570
|
+
# projects/123456789" display_name: "Cloud XXX Service Agent" description: "Used
|
|
2571
|
+
# as the identity of Cloud XXX to access resources"
|
|
3146
2572
|
class ServiceIdentity
|
|
3147
2573
|
include Google::Apis::Core::Hashable
|
|
3148
2574
|
|
|
3149
|
-
# Optional. A user-specified opaque description of the service account.
|
|
3150
|
-
#
|
|
2575
|
+
# Optional. A user-specified opaque description of the service account. Must be
|
|
2576
|
+
# less than or equal to 256 UTF-8 bytes.
|
|
3151
2577
|
# Corresponds to the JSON property `description`
|
|
3152
2578
|
# @return [String]
|
|
3153
2579
|
attr_accessor :description
|
|
3154
2580
|
|
|
3155
|
-
# Optional. A user-specified name for the service account.
|
|
3156
|
-
#
|
|
2581
|
+
# Optional. A user-specified name for the service account. Must be less than or
|
|
2582
|
+
# equal to 100 UTF-8 bytes.
|
|
3157
2583
|
# Corresponds to the JSON property `displayName`
|
|
3158
2584
|
# @return [String]
|
|
3159
2585
|
attr_accessor :display_name
|
|
3160
2586
|
|
|
3161
|
-
# A service account project that hosts the service accounts.
|
|
3162
|
-
#
|
|
3163
|
-
# `projects/123456789`
|
|
2587
|
+
# A service account project that hosts the service accounts. An example name
|
|
2588
|
+
# would be: `projects/123456789`
|
|
3164
2589
|
# Corresponds to the JSON property `serviceAccountParent`
|
|
3165
2590
|
# @return [String]
|
|
3166
2591
|
attr_accessor :service_account_parent
|
|
@@ -3177,13 +2602,13 @@ module Google
|
|
|
3177
2602
|
end
|
|
3178
2603
|
end
|
|
3179
2604
|
|
|
3180
|
-
# `SourceContext` represents information about the source of a
|
|
3181
|
-
#
|
|
2605
|
+
# `SourceContext` represents information about the source of a protobuf element,
|
|
2606
|
+
# like the file in which it is defined.
|
|
3182
2607
|
class SourceContext
|
|
3183
2608
|
include Google::Apis::Core::Hashable
|
|
3184
2609
|
|
|
3185
2610
|
# The path-qualified name of the .proto file that contained the associated
|
|
3186
|
-
# protobuf element.
|
|
2611
|
+
# protobuf element. For example: `"google/protobuf/source_context.proto"`.
|
|
3187
2612
|
# Corresponds to the JSON property `fileName`
|
|
3188
2613
|
# @return [String]
|
|
3189
2614
|
attr_accessor :file_name
|
|
@@ -3217,12 +2642,12 @@ module Google
|
|
|
3217
2642
|
end
|
|
3218
2643
|
end
|
|
3219
2644
|
|
|
3220
|
-
# The `Status` type defines a logical error model that is suitable for
|
|
3221
|
-
#
|
|
3222
|
-
#
|
|
3223
|
-
#
|
|
3224
|
-
#
|
|
3225
|
-
#
|
|
2645
|
+
# The `Status` type defines a logical error model that is suitable for different
|
|
2646
|
+
# programming environments, including REST APIs and RPC APIs. It is used by [
|
|
2647
|
+
# gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
|
|
2648
|
+
# data: error code, error message, and error details. You can find out more
|
|
2649
|
+
# about this error model and how to work with it in the [API Design Guide](https:
|
|
2650
|
+
# //cloud.google.com/apis/design/errors).
|
|
3226
2651
|
class Status
|
|
3227
2652
|
include Google::Apis::Core::Hashable
|
|
3228
2653
|
|
|
@@ -3231,15 +2656,15 @@ module Google
|
|
|
3231
2656
|
# @return [Fixnum]
|
|
3232
2657
|
attr_accessor :code
|
|
3233
2658
|
|
|
3234
|
-
# A list of messages that carry the error details.
|
|
2659
|
+
# A list of messages that carry the error details. There is a common set of
|
|
3235
2660
|
# message types for APIs to use.
|
|
3236
2661
|
# Corresponds to the JSON property `details`
|
|
3237
2662
|
# @return [Array<Hash<String,Object>>]
|
|
3238
2663
|
attr_accessor :details
|
|
3239
2664
|
|
|
3240
|
-
# A developer-facing error message, which should be in English. Any
|
|
3241
|
-
#
|
|
3242
|
-
#
|
|
2665
|
+
# A developer-facing error message, which should be in English. Any user-facing
|
|
2666
|
+
# error message should be localized and sent in the google.rpc.Status.details
|
|
2667
|
+
# field, or localized by the client.
|
|
3243
2668
|
# Corresponds to the JSON property `message`
|
|
3244
2669
|
# @return [String]
|
|
3245
2670
|
attr_accessor :message
|
|
@@ -3262,8 +2687,7 @@ module Google
|
|
|
3262
2687
|
class SystemParameter
|
|
3263
2688
|
include Google::Apis::Core::Hashable
|
|
3264
2689
|
|
|
3265
|
-
# Define the HTTP header name to use for the parameter. It is case
|
|
3266
|
-
# insensitive.
|
|
2690
|
+
# Define the HTTP header name to use for the parameter. It is case insensitive.
|
|
3267
2691
|
# Corresponds to the JSON property `httpHeader`
|
|
3268
2692
|
# @return [String]
|
|
3269
2693
|
attr_accessor :http_header
|
|
@@ -3291,23 +2715,20 @@ module Google
|
|
|
3291
2715
|
end
|
|
3292
2716
|
end
|
|
3293
2717
|
|
|
3294
|
-
# Define a system parameter rule mapping system parameter definitions to
|
|
3295
|
-
# methods.
|
|
2718
|
+
# Define a system parameter rule mapping system parameter definitions to methods.
|
|
3296
2719
|
class SystemParameterRule
|
|
3297
2720
|
include Google::Apis::Core::Hashable
|
|
3298
2721
|
|
|
3299
|
-
# Define parameters. Multiple names may be defined for a parameter.
|
|
3300
|
-
#
|
|
3301
|
-
#
|
|
3302
|
-
#
|
|
3303
|
-
# parameter-dependent.
|
|
2722
|
+
# Define parameters. Multiple names may be defined for a parameter. For a given
|
|
2723
|
+
# method call, only one of them should be used. If multiple names are used the
|
|
2724
|
+
# behavior is implementation-dependent. If none of the specified names are
|
|
2725
|
+
# present the behavior is parameter-dependent.
|
|
3304
2726
|
# Corresponds to the JSON property `parameters`
|
|
3305
2727
|
# @return [Array<Google::Apis::ServiceconsumermanagementV1beta1::SystemParameter>]
|
|
3306
2728
|
attr_accessor :parameters
|
|
3307
2729
|
|
|
3308
2730
|
# Selects the methods to which this rule applies. Use '*' to indicate all
|
|
3309
|
-
# methods in all APIs.
|
|
3310
|
-
# Refer to selector for syntax details.
|
|
2731
|
+
# methods in all APIs. Refer to selector for syntax details.
|
|
3311
2732
|
# Corresponds to the JSON property `selector`
|
|
3312
2733
|
# @return [String]
|
|
3313
2734
|
attr_accessor :selector
|
|
@@ -3323,36 +2744,23 @@ module Google
|
|
|
3323
2744
|
end
|
|
3324
2745
|
end
|
|
3325
2746
|
|
|
3326
|
-
# ### System parameter configuration
|
|
3327
|
-
#
|
|
3328
|
-
#
|
|
3329
|
-
#
|
|
3330
|
-
# change the names of the system parameters.
|
|
2747
|
+
# ### System parameter configuration A system parameter is a special kind of
|
|
2748
|
+
# parameter defined by the API system, not by an individual API. It is typically
|
|
2749
|
+
# mapped to an HTTP header and/or a URL query parameter. This configuration
|
|
2750
|
+
# specifies which methods change the names of the system parameters.
|
|
3331
2751
|
class SystemParameters
|
|
3332
2752
|
include Google::Apis::Core::Hashable
|
|
3333
2753
|
|
|
3334
|
-
# Define system parameters.
|
|
3335
|
-
#
|
|
3336
|
-
#
|
|
3337
|
-
#
|
|
3338
|
-
#
|
|
3339
|
-
# Example: define api key for
|
|
3340
|
-
# system_parameters
|
|
3341
|
-
#
|
|
3342
|
-
# -
|
|
3343
|
-
#
|
|
3344
|
-
# - name: api_key
|
|
3345
|
-
# url_query_parameter: api_key
|
|
3346
|
-
# Example: define 2 api key names for a specific method.
|
|
3347
|
-
# system_parameters
|
|
3348
|
-
# rules:
|
|
3349
|
-
# - selector: "/ListShelves"
|
|
3350
|
-
# parameters:
|
|
3351
|
-
# - name: api_key
|
|
3352
|
-
# http_header: Api-Key1
|
|
3353
|
-
# - name: api_key
|
|
3354
|
-
# http_header: Api-Key2
|
|
3355
|
-
# **NOTE:** All service configuration rules follow "last one wins" order.
|
|
2754
|
+
# Define system parameters. The parameters defined here will override the
|
|
2755
|
+
# default parameters implemented by the system. If this field is missing from
|
|
2756
|
+
# the service config, default system parameters will be used. Default system
|
|
2757
|
+
# parameters and names is implementation-dependent. Example: define api key for
|
|
2758
|
+
# all methods system_parameters rules: - selector: "*" parameters: - name:
|
|
2759
|
+
# api_key url_query_parameter: api_key Example: define 2 api key names for a
|
|
2760
|
+
# specific method. system_parameters rules: - selector: "/ListShelves"
|
|
2761
|
+
# parameters: - name: api_key http_header: Api-Key1 - name: api_key http_header:
|
|
2762
|
+
# Api-Key2 **NOTE:** All service configuration rules follow "last one wins"
|
|
2763
|
+
# order.
|
|
3356
2764
|
# Corresponds to the JSON property `rules`
|
|
3357
2765
|
# @return [Array<Google::Apis::ServiceconsumermanagementV1beta1::SystemParameterRule>]
|
|
3358
2766
|
attr_accessor :rules
|
|
@@ -3391,8 +2799,8 @@ module Google
|
|
|
3391
2799
|
# @return [Array<Google::Apis::ServiceconsumermanagementV1beta1::Option>]
|
|
3392
2800
|
attr_accessor :options
|
|
3393
2801
|
|
|
3394
|
-
# `SourceContext` represents information about the source of a
|
|
3395
|
-
#
|
|
2802
|
+
# `SourceContext` represents information about the source of a protobuf element,
|
|
2803
|
+
# like the file in which it is defined.
|
|
3396
2804
|
# Corresponds to the JSON property `sourceContext`
|
|
3397
2805
|
# @return [Google::Apis::ServiceconsumermanagementV1beta1::SourceContext]
|
|
3398
2806
|
attr_accessor :source_context
|
|
@@ -3422,37 +2830,33 @@ module Google
|
|
|
3422
2830
|
include Google::Apis::Core::Hashable
|
|
3423
2831
|
|
|
3424
2832
|
# The full resource name of a channel used for sending notifications to the
|
|
3425
|
-
# service producer.
|
|
3426
|
-
#
|
|
3427
|
-
#
|
|
3428
|
-
#
|
|
3429
|
-
#
|
|
3430
|
-
# documented in https://cloud.google.com/pubsub/docs/overview.
|
|
2833
|
+
# service producer. Google Service Management currently only supports [Google
|
|
2834
|
+
# Cloud Pub/Sub](https://cloud.google.com/pubsub) as a notification channel. To
|
|
2835
|
+
# use Google Cloud Pub/Sub as the channel, this must be the name of a Cloud Pub/
|
|
2836
|
+
# Sub topic that uses the Cloud Pub/Sub topic name format documented in https://
|
|
2837
|
+
# cloud.google.com/pubsub/docs/overview.
|
|
3431
2838
|
# Corresponds to the JSON property `producerNotificationChannel`
|
|
3432
2839
|
# @return [String]
|
|
3433
2840
|
attr_accessor :producer_notification_channel
|
|
3434
2841
|
|
|
3435
2842
|
# Requirements that must be satisfied before a consumer project can use the
|
|
3436
|
-
# service. Each requirement is of the form
|
|
3437
|
-
#
|
|
2843
|
+
# service. Each requirement is of the form /; for example 'serviceusage.
|
|
2844
|
+
# googleapis.com/billing-enabled'.
|
|
3438
2845
|
# Corresponds to the JSON property `requirements`
|
|
3439
2846
|
# @return [Array<String>]
|
|
3440
2847
|
attr_accessor :requirements
|
|
3441
2848
|
|
|
3442
|
-
# A list of usage rules that apply to individual API methods.
|
|
3443
|
-
#
|
|
2849
|
+
# A list of usage rules that apply to individual API methods. **NOTE:** All
|
|
2850
|
+
# service configuration rules follow "last one wins" order.
|
|
3444
2851
|
# Corresponds to the JSON property `rules`
|
|
3445
2852
|
# @return [Array<Google::Apis::ServiceconsumermanagementV1beta1::UsageRule>]
|
|
3446
2853
|
attr_accessor :rules
|
|
3447
2854
|
|
|
3448
|
-
# The per-product per-project service identity for a service.
|
|
3449
|
-
#
|
|
3450
|
-
#
|
|
3451
|
-
#
|
|
3452
|
-
#
|
|
3453
|
-
# - service_account_parent: "projects/123456789"
|
|
3454
|
-
# display_name: "Cloud XXX Service Agent"
|
|
3455
|
-
# description: "Used as the identity of Cloud XXX to access resources"
|
|
2855
|
+
# The per-product per-project service identity for a service. Use this field to
|
|
2856
|
+
# configure per-product per-project service identity. Example of a service
|
|
2857
|
+
# identity configuration. usage: service_identity: - service_account_parent: "
|
|
2858
|
+
# projects/123456789" display_name: "Cloud XXX Service Agent" description: "Used
|
|
2859
|
+
# as the identity of Cloud XXX to access resources"
|
|
3456
2860
|
# Corresponds to the JSON property `serviceIdentity`
|
|
3457
2861
|
# @return [Google::Apis::ServiceconsumermanagementV1beta1::ServiceIdentity]
|
|
3458
2862
|
attr_accessor :service_identity
|
|
@@ -3470,45 +2874,36 @@ module Google
|
|
|
3470
2874
|
end
|
|
3471
2875
|
end
|
|
3472
2876
|
|
|
3473
|
-
# Usage configuration rules for the service.
|
|
3474
|
-
#
|
|
3475
|
-
#
|
|
3476
|
-
#
|
|
3477
|
-
#
|
|
3478
|
-
#
|
|
3479
|
-
#
|
|
3480
|
-
#
|
|
3481
|
-
#
|
|
3482
|
-
#
|
|
3483
|
-
# rules:
|
|
3484
|
-
# - selector: "*"
|
|
3485
|
-
# allow_unregistered_calls: true
|
|
3486
|
-
# Example of a method that wants to allow unregistered calls.
|
|
3487
|
-
# usage:
|
|
3488
|
-
# rules:
|
|
3489
|
-
# - selector: "google.example.library.v1.LibraryService.CreateBook"
|
|
3490
|
-
# allow_unregistered_calls: true
|
|
2877
|
+
# Usage configuration rules for the service. NOTE: Under development. Use this
|
|
2878
|
+
# rule to configure unregistered calls for the service. Unregistered calls are
|
|
2879
|
+
# calls that do not contain consumer project identity. (Example: calls that do
|
|
2880
|
+
# not contain an API key). By default, API methods do not allow unregistered
|
|
2881
|
+
# calls, and each method call must be identified by a consumer project identity.
|
|
2882
|
+
# Use this rule to allow/disallow unregistered calls. Example of an API that
|
|
2883
|
+
# wants to allow unregistered calls for entire service. usage: rules: - selector:
|
|
2884
|
+
# "*" allow_unregistered_calls: true Example of a method that wants to allow
|
|
2885
|
+
# unregistered calls. usage: rules: - selector: "google.example.library.v1.
|
|
2886
|
+
# LibraryService.CreateBook" allow_unregistered_calls: true
|
|
3491
2887
|
class UsageRule
|
|
3492
2888
|
include Google::Apis::Core::Hashable
|
|
3493
2889
|
|
|
3494
|
-
# If true, the selected method allows unregistered calls, e.g. calls
|
|
3495
|
-
#
|
|
2890
|
+
# If true, the selected method allows unregistered calls, e.g. calls that don't
|
|
2891
|
+
# identify any user or application.
|
|
3496
2892
|
# Corresponds to the JSON property `allowUnregisteredCalls`
|
|
3497
2893
|
# @return [Boolean]
|
|
3498
2894
|
attr_accessor :allow_unregistered_calls
|
|
3499
2895
|
alias_method :allow_unregistered_calls?, :allow_unregistered_calls
|
|
3500
2896
|
|
|
3501
2897
|
# Selects the methods to which this rule applies. Use '*' to indicate all
|
|
3502
|
-
# methods in all APIs.
|
|
3503
|
-
# Refer to selector for syntax details.
|
|
2898
|
+
# methods in all APIs. Refer to selector for syntax details.
|
|
3504
2899
|
# Corresponds to the JSON property `selector`
|
|
3505
2900
|
# @return [String]
|
|
3506
2901
|
attr_accessor :selector
|
|
3507
2902
|
|
|
3508
|
-
# If true, the selected method should skip service control and the control
|
|
3509
|
-
#
|
|
3510
|
-
#
|
|
3511
|
-
#
|
|
2903
|
+
# If true, the selected method should skip service control and the control plane
|
|
2904
|
+
# features, such as quota and billing, will not be available. This flag is used
|
|
2905
|
+
# by Google Cloud Endpoints to bypass checks for internal methods, such as
|
|
2906
|
+
# service health check methods.
|
|
3512
2907
|
# Corresponds to the JSON property `skipServiceControl`
|
|
3513
2908
|
# @return [Boolean]
|
|
3514
2909
|
attr_accessor :skip_service_control
|
|
@@ -3555,35 +2950,31 @@ module Google
|
|
|
3555
2950
|
attr_accessor :is_precise
|
|
3556
2951
|
alias_method :is_precise?, :is_precise
|
|
3557
2952
|
|
|
3558
|
-
# The name of the parent metric of this limit.
|
|
3559
|
-
#
|
|
3560
|
-
# `compute.googleapis.com/cpus`
|
|
2953
|
+
# The name of the parent metric of this limit. An example name would be: `
|
|
2954
|
+
# compute.googleapis.com/cpus`
|
|
3561
2955
|
# Corresponds to the JSON property `metric`
|
|
3562
2956
|
# @return [String]
|
|
3563
2957
|
attr_accessor :metric
|
|
3564
2958
|
|
|
3565
|
-
# The resource name of the quota limit.
|
|
3566
|
-
#
|
|
3567
|
-
# `
|
|
3568
|
-
#
|
|
3569
|
-
#
|
|
3570
|
-
# its component strings, since its representation could change in the future.
|
|
2959
|
+
# The resource name of the quota limit. An example name would be: `services/
|
|
2960
|
+
# compute.googleapis.com/projects/123/quotas/metrics/compute.googleapis.com%
|
|
2961
|
+
# 2Fcpus/limits/%2Fproject%2Fregion` The resource name is intended to be opaque
|
|
2962
|
+
# and should not be parsed for its component strings, since its representation
|
|
2963
|
+
# could change in the future.
|
|
3571
2964
|
# Corresponds to the JSON property `name`
|
|
3572
2965
|
# @return [String]
|
|
3573
2966
|
attr_accessor :name
|
|
3574
2967
|
|
|
3575
|
-
# Summary of the enforced quota buckets, organized by quota dimension,
|
|
3576
|
-
#
|
|
3577
|
-
#
|
|
2968
|
+
# Summary of the enforced quota buckets, organized by quota dimension, ordered
|
|
2969
|
+
# from least specific to most specific (for example, the global default bucket,
|
|
2970
|
+
# with no quota dimensions, will always appear first).
|
|
3578
2971
|
# Corresponds to the JSON property `quotaBuckets`
|
|
3579
2972
|
# @return [Array<Google::Apis::ServiceconsumermanagementV1beta1::V1Beta1QuotaBucket>]
|
|
3580
2973
|
attr_accessor :quota_buckets
|
|
3581
2974
|
|
|
3582
|
-
# The limit unit.
|
|
3583
|
-
#
|
|
3584
|
-
#
|
|
3585
|
-
# Note that ``project`` and ``region`` are not placeholders in this example;
|
|
3586
|
-
# the literal characters ``` and ``` occur in the string.
|
|
2975
|
+
# The limit unit. An example unit would be: `1/`project`/`region`` Note that ``
|
|
2976
|
+
# project`` and ``region`` are not placeholders in this example; the literal
|
|
2977
|
+
# characters ``` and ``` occur in the string.
|
|
3587
2978
|
# Corresponds to the JSON property `unit`
|
|
3588
2979
|
# @return [String]
|
|
3589
2980
|
attr_accessor :unit
|
|
@@ -3611,26 +3002,21 @@ module Google
|
|
|
3611
3002
|
# @return [Array<Google::Apis::ServiceconsumermanagementV1beta1::V1Beta1ConsumerQuotaLimit>]
|
|
3612
3003
|
attr_accessor :consumer_quota_limits
|
|
3613
3004
|
|
|
3614
|
-
# The display name of the metric.
|
|
3615
|
-
# An example name would be:
|
|
3616
|
-
# "CPUs"
|
|
3005
|
+
# The display name of the metric. An example name would be: "CPUs"
|
|
3617
3006
|
# Corresponds to the JSON property `displayName`
|
|
3618
3007
|
# @return [String]
|
|
3619
3008
|
attr_accessor :display_name
|
|
3620
3009
|
|
|
3621
|
-
# The name of the metric.
|
|
3622
|
-
# An example name would be:
|
|
3623
|
-
# `compute.googleapis.com/cpus`
|
|
3010
|
+
# The name of the metric. An example name would be: `compute.googleapis.com/cpus`
|
|
3624
3011
|
# Corresponds to the JSON property `metric`
|
|
3625
3012
|
# @return [String]
|
|
3626
3013
|
attr_accessor :metric
|
|
3627
3014
|
|
|
3628
|
-
# The resource name of the quota settings on this metric for this consumer.
|
|
3629
|
-
#
|
|
3630
|
-
#
|
|
3631
|
-
#
|
|
3632
|
-
#
|
|
3633
|
-
# its component strings, since its representation could change in the future.
|
|
3015
|
+
# The resource name of the quota settings on this metric for this consumer. An
|
|
3016
|
+
# example name would be: `services/serviceconsumermanagement.googleapis.com/
|
|
3017
|
+
# projects/123/quota/metrics/compute.googleapis.com%2Fcpus The resource name is
|
|
3018
|
+
# intended to be opaque and should not be parsed for its component strings,
|
|
3019
|
+
# since its representation could change in the future.
|
|
3634
3020
|
# Corresponds to the JSON property `name`
|
|
3635
3021
|
# @return [String]
|
|
3636
3022
|
attr_accessor :name
|
|
@@ -3654,9 +3040,9 @@ module Google
|
|
|
3654
3040
|
end
|
|
3655
3041
|
end
|
|
3656
3042
|
|
|
3657
|
-
# Response message for the `DisableConsumer` method.
|
|
3658
|
-
#
|
|
3659
|
-
#
|
|
3043
|
+
# Response message for the `DisableConsumer` method. This response message is
|
|
3044
|
+
# assigned to the `response` field of the returned Operation when that operation
|
|
3045
|
+
# is done.
|
|
3660
3046
|
class V1Beta1DisableConsumerResponse
|
|
3661
3047
|
include Google::Apis::Core::Hashable
|
|
3662
3048
|
|
|
@@ -3669,9 +3055,9 @@ module Google
|
|
|
3669
3055
|
end
|
|
3670
3056
|
end
|
|
3671
3057
|
|
|
3672
|
-
# Response message for the `EnableConsumer` method.
|
|
3673
|
-
#
|
|
3674
|
-
#
|
|
3058
|
+
# Response message for the `EnableConsumer` method. This response message is
|
|
3059
|
+
# assigned to the `response` field of the returned Operation when that operation
|
|
3060
|
+
# is done.
|
|
3675
3061
|
class V1Beta1EnableConsumerResponse
|
|
3676
3062
|
include Google::Apis::Core::Hashable
|
|
3677
3063
|
|
|
@@ -3684,9 +3070,9 @@ module Google
|
|
|
3684
3070
|
end
|
|
3685
3071
|
end
|
|
3686
3072
|
|
|
3687
|
-
# Response message for the `GenerateServiceIdentity` method.
|
|
3688
|
-
#
|
|
3689
|
-
#
|
|
3073
|
+
# Response message for the `GenerateServiceIdentity` method. This response
|
|
3074
|
+
# message is assigned to the `response` field of the returned Operation when
|
|
3075
|
+
# that operation is done.
|
|
3690
3076
|
class V1Beta1GenerateServiceIdentityResponse
|
|
3691
3077
|
include Google::Apis::Core::Hashable
|
|
3692
3078
|
|
|
@@ -3709,11 +3095,11 @@ module Google
|
|
|
3709
3095
|
class V1Beta1ImportProducerOverridesRequest
|
|
3710
3096
|
include Google::Apis::Core::Hashable
|
|
3711
3097
|
|
|
3712
|
-
# Whether to force the creation of the quota overrides.
|
|
3713
|
-
#
|
|
3714
|
-
#
|
|
3715
|
-
#
|
|
3716
|
-
#
|
|
3098
|
+
# Whether to force the creation of the quota overrides. If creating an override
|
|
3099
|
+
# would cause the effective quota for the consumer to decrease by more than 10
|
|
3100
|
+
# percent, the call is rejected, as a safety measure to avoid accidentally
|
|
3101
|
+
# decreasing quota too quickly. Setting the force parameter to true ignores this
|
|
3102
|
+
# restriction.
|
|
3717
3103
|
# Corresponds to the JSON property `force`
|
|
3718
3104
|
# @return [Boolean]
|
|
3719
3105
|
attr_accessor :force
|
|
@@ -3782,8 +3168,7 @@ module Google
|
|
|
3782
3168
|
# @return [Array<Google::Apis::ServiceconsumermanagementV1beta1::V1Beta1ConsumerQuotaMetric>]
|
|
3783
3169
|
attr_accessor :metrics
|
|
3784
3170
|
|
|
3785
|
-
# Token identifying which result to start with; returned by a previous list
|
|
3786
|
-
# call.
|
|
3171
|
+
# Token identifying which result to start with; returned by a previous list call.
|
|
3787
3172
|
# Corresponds to the JSON property `nextPageToken`
|
|
3788
3173
|
# @return [String]
|
|
3789
3174
|
attr_accessor :next_page_token
|
|
@@ -3803,8 +3188,7 @@ module Google
|
|
|
3803
3188
|
class V1Beta1ListProducerOverridesResponse
|
|
3804
3189
|
include Google::Apis::Core::Hashable
|
|
3805
3190
|
|
|
3806
|
-
# Token identifying which result to start with; returned by a previous list
|
|
3807
|
-
# call.
|
|
3191
|
+
# Token identifying which result to start with; returned by a previous list call.
|
|
3808
3192
|
# Corresponds to the JSON property `nextPageToken`
|
|
3809
3193
|
# @return [String]
|
|
3810
3194
|
attr_accessor :next_page_token
|
|
@@ -3829,9 +3213,9 @@ module Google
|
|
|
3829
3213
|
class V1Beta1OverrideInlineSource
|
|
3830
3214
|
include Google::Apis::Core::Hashable
|
|
3831
3215
|
|
|
3832
|
-
# The overrides to create.
|
|
3833
|
-
#
|
|
3834
|
-
#
|
|
3216
|
+
# The overrides to create. Each override must have a value for 'metric' and '
|
|
3217
|
+
# unit', to specify which metric and which limit the override should be applied
|
|
3218
|
+
# to.
|
|
3835
3219
|
# Corresponds to the JSON property `overrides`
|
|
3836
3220
|
# @return [Array<Google::Apis::ServiceconsumermanagementV1beta1::V1Beta1QuotaOverride>]
|
|
3837
3221
|
attr_accessor :overrides
|
|
@@ -3850,61 +3234,54 @@ module Google
|
|
|
3850
3234
|
class V1Beta1ProducerQuotaPolicy
|
|
3851
3235
|
include Google::Apis::Core::Hashable
|
|
3852
3236
|
|
|
3853
|
-
# The cloud resource container at which the quota policy is created. The
|
|
3854
|
-
#
|
|
3237
|
+
# The cloud resource container at which the quota policy is created. The format
|
|
3238
|
+
# is `container_type`/`container_number`
|
|
3855
3239
|
# Corresponds to the JSON property `container`
|
|
3856
3240
|
# @return [String]
|
|
3857
3241
|
attr_accessor :container
|
|
3858
3242
|
|
|
3859
|
-
# If this map is nonempty, then this policy applies only to specific values
|
|
3860
|
-
#
|
|
3861
|
-
#
|
|
3862
|
-
#
|
|
3863
|
-
#
|
|
3864
|
-
#
|
|
3865
|
-
#
|
|
3866
|
-
#
|
|
3867
|
-
#
|
|
3868
|
-
# *
|
|
3869
|
-
#
|
|
3870
|
-
# *
|
|
3871
|
-
#
|
|
3872
|
-
# * If "region" appears as a key, its value must be a valid Cloud region.
|
|
3873
|
-
# * If "zone" appears as a key, its value must be a valid Cloud zone.
|
|
3874
|
-
# * If any valid key other than "region" or "zone" appears in the map, then
|
|
3875
|
-
# all valid keys other than "region" or "zone" must also appear in the
|
|
3243
|
+
# If this map is nonempty, then this policy applies only to specific values for
|
|
3244
|
+
# dimensions defined in the limit unit. For example, an policy on a limit with
|
|
3245
|
+
# the unit 1/`project`/`region` could contain an entry with the key "region" and
|
|
3246
|
+
# the value "us-east-1"; the policy is only applied to quota consumed in that
|
|
3247
|
+
# region. This map has the following restrictions: * Keys that are not defined
|
|
3248
|
+
# in the limit's unit are not valid keys. Any string appearing in `brackets` in
|
|
3249
|
+
# the unit (besides `project` or `user`) is a defined key. * "project" is not a
|
|
3250
|
+
# valid key; the project is already specified in the parent resource name. * "
|
|
3251
|
+
# user" is not a valid key; the API does not support quota polcies that apply
|
|
3252
|
+
# only to a specific user. * If "region" appears as a key, its value must be a
|
|
3253
|
+
# valid Cloud region. * If "zone" appears as a key, its value must be a valid
|
|
3254
|
+
# Cloud zone. * If any valid key other than "region" or "zone" appears in the
|
|
3255
|
+
# map, then all valid keys other than "region" or "zone" must also appear in the
|
|
3876
3256
|
# map.
|
|
3877
3257
|
# Corresponds to the JSON property `dimensions`
|
|
3878
3258
|
# @return [Hash<String,String>]
|
|
3879
3259
|
attr_accessor :dimensions
|
|
3880
3260
|
|
|
3881
|
-
# The name of the metric to which this policy applies.
|
|
3882
|
-
# An example name would be:
|
|
3261
|
+
# The name of the metric to which this policy applies. An example name would be:
|
|
3883
3262
|
# `compute.googleapis.com/cpus`
|
|
3884
3263
|
# Corresponds to the JSON property `metric`
|
|
3885
3264
|
# @return [String]
|
|
3886
3265
|
attr_accessor :metric
|
|
3887
3266
|
|
|
3888
|
-
# The resource name of the producer policy.
|
|
3889
|
-
#
|
|
3890
|
-
#
|
|
3891
|
-
# compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/producerQuotaPolicies/
|
|
3267
|
+
# The resource name of the producer policy. An example name would be: `services/
|
|
3268
|
+
# compute.googleapis.com/organizations/123/consumerQuotaMetrics/compute.
|
|
3269
|
+
# googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/producerQuotaPolicies/
|
|
3892
3270
|
# 4a3f2c1d`
|
|
3893
3271
|
# Corresponds to the JSON property `name`
|
|
3894
3272
|
# @return [String]
|
|
3895
3273
|
attr_accessor :name
|
|
3896
3274
|
|
|
3897
|
-
# The quota policy value.
|
|
3898
|
-
#
|
|
3275
|
+
# The quota policy value. Can be any nonnegative integer, or -1 (unlimited quota)
|
|
3276
|
+
# .
|
|
3899
3277
|
# Corresponds to the JSON property `policyValue`
|
|
3900
3278
|
# @return [Fixnum]
|
|
3901
3279
|
attr_accessor :policy_value
|
|
3902
3280
|
|
|
3903
|
-
# The limit unit of the limit to which this policy applies.
|
|
3904
|
-
#
|
|
3905
|
-
#
|
|
3906
|
-
#
|
|
3907
|
-
# the literal characters ``` and ``` occur in the string.
|
|
3281
|
+
# The limit unit of the limit to which this policy applies. An example unit
|
|
3282
|
+
# would be: `1/`project`/`region`` Note that ``project`` and ``region`` are not
|
|
3283
|
+
# placeholders in this example; the literal characters ``` and ``` occur in the
|
|
3284
|
+
# string.
|
|
3908
3285
|
# Corresponds to the JSON property `unit`
|
|
3909
3286
|
# @return [String]
|
|
3910
3287
|
attr_accessor :unit
|
|
@@ -3944,20 +3321,19 @@ module Google
|
|
|
3944
3321
|
# @return [Fixnum]
|
|
3945
3322
|
attr_accessor :default_limit
|
|
3946
3323
|
|
|
3947
|
-
# The dimensions of this quota bucket.
|
|
3948
|
-
#
|
|
3949
|
-
#
|
|
3950
|
-
#
|
|
3951
|
-
#
|
|
3952
|
-
#
|
|
3953
|
-
# specified
|
|
3954
|
-
# specified overrides apply only in that region.
|
|
3324
|
+
# The dimensions of this quota bucket. If this map is empty, this is the global
|
|
3325
|
+
# bucket, which is the default quota value applied to all requests that do not
|
|
3326
|
+
# have a more specific override. If this map is nonempty, the default limit,
|
|
3327
|
+
# effective limit, and quota overrides apply only to requests that have the
|
|
3328
|
+
# dimensions given in the map. For example, if the map has key "region" and
|
|
3329
|
+
# value "us-east-1", then the specified effective limit is only effective in
|
|
3330
|
+
# that region, and the specified overrides apply only in that region.
|
|
3955
3331
|
# Corresponds to the JSON property `dimensions`
|
|
3956
3332
|
# @return [Hash<String,String>]
|
|
3957
3333
|
attr_accessor :dimensions
|
|
3958
3334
|
|
|
3959
|
-
# The effective limit of this quota bucket. Equal to default_limit if there
|
|
3960
|
-
#
|
|
3335
|
+
# The effective limit of this quota bucket. Equal to default_limit if there are
|
|
3336
|
+
# no overrides.
|
|
3961
3337
|
# Corresponds to the JSON property `effectiveLimit`
|
|
3962
3338
|
# @return [Fixnum]
|
|
3963
3339
|
attr_accessor :effective_limit
|
|
@@ -3986,61 +3362,53 @@ module Google
|
|
|
3986
3362
|
class V1Beta1QuotaOverride
|
|
3987
3363
|
include Google::Apis::Core::Hashable
|
|
3988
3364
|
|
|
3989
|
-
# The resource name of the ancestor that requested the override. For example:
|
|
3990
|
-
#
|
|
3991
|
-
# Used by admin overrides only.
|
|
3365
|
+
# The resource name of the ancestor that requested the override. For example: "
|
|
3366
|
+
# organizations/12345" or "folders/67890". Used by admin overrides only.
|
|
3992
3367
|
# Corresponds to the JSON property `adminOverrideAncestor`
|
|
3993
3368
|
# @return [String]
|
|
3994
3369
|
attr_accessor :admin_override_ancestor
|
|
3995
3370
|
|
|
3996
3371
|
# If this map is nonempty, then this override applies only to specific values
|
|
3997
|
-
# for dimensions defined in the limit unit.
|
|
3998
|
-
#
|
|
3999
|
-
#
|
|
4000
|
-
#
|
|
4001
|
-
#
|
|
4002
|
-
#
|
|
4003
|
-
#
|
|
4004
|
-
#
|
|
4005
|
-
#
|
|
4006
|
-
#
|
|
4007
|
-
#
|
|
4008
|
-
#
|
|
4009
|
-
#
|
|
4010
|
-
# * If "zone" appears as a key, its value must be a valid Cloud zone.
|
|
4011
|
-
# * If any valid key other than "region" or "zone" appears in the map, then
|
|
4012
|
-
# all valid keys other than "region" or "zone" must also appear in the
|
|
4013
|
-
# map.
|
|
3372
|
+
# for dimensions defined in the limit unit. For example, an override on a limit
|
|
3373
|
+
# with the unit 1/`project`/`region` could contain an entry with the key "region"
|
|
3374
|
+
# and the value "us-east-1"; the override is only applied to quota consumed in
|
|
3375
|
+
# that region. This map has the following restrictions: * Keys that are not
|
|
3376
|
+
# defined in the limit's unit are not valid keys. Any string appearing in `
|
|
3377
|
+
# brackets` in the unit (besides `project` or `user`) is a defined key. * "
|
|
3378
|
+
# project" is not a valid key; the project is already specified in the parent
|
|
3379
|
+
# resource name. * "user" is not a valid key; the API does not support quota
|
|
3380
|
+
# overrides that apply only to a specific user. * If "region" appears as a key,
|
|
3381
|
+
# its value must be a valid Cloud region. * If "zone" appears as a key, its
|
|
3382
|
+
# value must be a valid Cloud zone. * If any valid key other than "region" or "
|
|
3383
|
+
# zone" appears in the map, then all valid keys other than "region" or "zone"
|
|
3384
|
+
# must also appear in the map.
|
|
4014
3385
|
# Corresponds to the JSON property `dimensions`
|
|
4015
3386
|
# @return [Hash<String,String>]
|
|
4016
3387
|
attr_accessor :dimensions
|
|
4017
3388
|
|
|
4018
|
-
# The name of the metric to which this override applies.
|
|
4019
|
-
#
|
|
4020
|
-
# `compute.googleapis.com/cpus`
|
|
3389
|
+
# The name of the metric to which this override applies. An example name would
|
|
3390
|
+
# be: `compute.googleapis.com/cpus`
|
|
4021
3391
|
# Corresponds to the JSON property `metric`
|
|
4022
3392
|
# @return [String]
|
|
4023
3393
|
attr_accessor :metric
|
|
4024
3394
|
|
|
4025
|
-
# The resource name of the producer override.
|
|
4026
|
-
#
|
|
4027
|
-
# `services/compute.googleapis.com/projects/123/consumerQuotaMetrics/compute.
|
|
3395
|
+
# The resource name of the producer override. An example name would be: `
|
|
3396
|
+
# services/compute.googleapis.com/projects/123/consumerQuotaMetrics/compute.
|
|
4028
3397
|
# googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/producerOverrides/4a3f2c1d`
|
|
4029
3398
|
# Corresponds to the JSON property `name`
|
|
4030
3399
|
# @return [String]
|
|
4031
3400
|
attr_accessor :name
|
|
4032
3401
|
|
|
4033
|
-
# The overriding quota limit value.
|
|
4034
|
-
#
|
|
3402
|
+
# The overriding quota limit value. Can be any nonnegative integer, or -1 (
|
|
3403
|
+
# unlimited quota).
|
|
4035
3404
|
# Corresponds to the JSON property `overrideValue`
|
|
4036
3405
|
# @return [Fixnum]
|
|
4037
3406
|
attr_accessor :override_value
|
|
4038
3407
|
|
|
4039
|
-
# The limit unit of the limit to which this override applies.
|
|
4040
|
-
#
|
|
4041
|
-
#
|
|
4042
|
-
#
|
|
4043
|
-
# the literal characters ``` and ``` occur in the string.
|
|
3408
|
+
# The limit unit of the limit to which this override applies. An example unit
|
|
3409
|
+
# would be: `1/`project`/`region`` Note that ``project`` and ``region`` are not
|
|
3410
|
+
# placeholders in this example; the literal characters ``` and ``` occur in the
|
|
3411
|
+
# string.
|
|
4044
3412
|
# Corresponds to the JSON property `unit`
|
|
4045
3413
|
# @return [String]
|
|
4046
3414
|
attr_accessor :unit
|
|
@@ -4060,9 +3428,9 @@ module Google
|
|
|
4060
3428
|
end
|
|
4061
3429
|
end
|
|
4062
3430
|
|
|
4063
|
-
# Response message for the `RefreshConsumer` method.
|
|
4064
|
-
#
|
|
4065
|
-
#
|
|
3431
|
+
# Response message for the `RefreshConsumer` method. This response message is
|
|
3432
|
+
# assigned to the `response` field of the returned Operation when that operation
|
|
3433
|
+
# is done.
|
|
4066
3434
|
class V1Beta1RefreshConsumerResponse
|
|
4067
3435
|
include Google::Apis::Core::Hashable
|
|
4068
3436
|
|
|
@@ -4084,17 +3452,16 @@ module Google
|
|
|
4084
3452
|
# @return [String]
|
|
4085
3453
|
attr_accessor :email
|
|
4086
3454
|
|
|
4087
|
-
# P4 service identity resource name.
|
|
4088
|
-
#
|
|
4089
|
-
# `
|
|
4090
|
-
# serviceIdentities/default`
|
|
3455
|
+
# P4 service identity resource name. An example name would be: `services/
|
|
3456
|
+
# serviceconsumermanagement.googleapis.com/projects/123/serviceIdentities/
|
|
3457
|
+
# default`
|
|
4091
3458
|
# Corresponds to the JSON property `name`
|
|
4092
3459
|
# @return [String]
|
|
4093
3460
|
attr_accessor :name
|
|
4094
3461
|
|
|
4095
3462
|
# The P4 service identity configuration tag. This must be defined in
|
|
4096
|
-
# activation_grants. If not specified when creating the account, the tag is
|
|
4097
|
-
#
|
|
3463
|
+
# activation_grants. If not specified when creating the account, the tag is set
|
|
3464
|
+
# to "default".
|
|
4098
3465
|
# Corresponds to the JSON property `tag`
|
|
4099
3466
|
# @return [String]
|
|
4100
3467
|
attr_accessor :tag
|
|
@@ -4117,9 +3484,9 @@ module Google
|
|
|
4117
3484
|
end
|
|
4118
3485
|
end
|
|
4119
3486
|
|
|
4120
|
-
# Response message for the `AddVisibilityLabels` method.
|
|
4121
|
-
#
|
|
4122
|
-
#
|
|
3487
|
+
# Response message for the `AddVisibilityLabels` method. This response message
|
|
3488
|
+
# is assigned to the `response` field of the returned Operation when that
|
|
3489
|
+
# operation is done.
|
|
4123
3490
|
class V1beta1AddVisibilityLabelsResponse
|
|
4124
3491
|
include Google::Apis::Core::Hashable
|
|
4125
3492
|
|
|
@@ -4147,10 +3514,8 @@ module Google
|
|
|
4147
3514
|
# @return [String]
|
|
4148
3515
|
attr_accessor :email
|
|
4149
3516
|
|
|
4150
|
-
# Default identity resource name.
|
|
4151
|
-
#
|
|
4152
|
-
# `services/serviceconsumermanagement.googleapis.com/projects/123/
|
|
4153
|
-
# defaultIdentity`
|
|
3517
|
+
# Default identity resource name. An example name would be: `services/
|
|
3518
|
+
# serviceconsumermanagement.googleapis.com/projects/123/defaultIdentity`
|
|
4154
3519
|
# Corresponds to the JSON property `name`
|
|
4155
3520
|
# @return [String]
|
|
4156
3521
|
attr_accessor :name
|
|
@@ -4172,9 +3537,9 @@ module Google
|
|
|
4172
3537
|
end
|
|
4173
3538
|
end
|
|
4174
3539
|
|
|
4175
|
-
# Response message for the `DisableConsumer` method.
|
|
4176
|
-
#
|
|
4177
|
-
#
|
|
3540
|
+
# Response message for the `DisableConsumer` method. This response message is
|
|
3541
|
+
# assigned to the `response` field of the returned Operation when that operation
|
|
3542
|
+
# is done.
|
|
4178
3543
|
class V1beta1DisableConsumerResponse
|
|
4179
3544
|
include Google::Apis::Core::Hashable
|
|
4180
3545
|
|
|
@@ -4187,9 +3552,9 @@ module Google
|
|
|
4187
3552
|
end
|
|
4188
3553
|
end
|
|
4189
3554
|
|
|
4190
|
-
# Response message for the `EnableConsumer` method.
|
|
4191
|
-
#
|
|
4192
|
-
#
|
|
3555
|
+
# Response message for the `EnableConsumer` method. This response message is
|
|
3556
|
+
# assigned to the `response` field of the returned Operation when that operation
|
|
3557
|
+
# is done.
|
|
4193
3558
|
class V1beta1EnableConsumerResponse
|
|
4194
3559
|
include Google::Apis::Core::Hashable
|
|
4195
3560
|
|
|
@@ -4202,9 +3567,9 @@ module Google
|
|
|
4202
3567
|
end
|
|
4203
3568
|
end
|
|
4204
3569
|
|
|
4205
|
-
# Response message for the `GenerateDefaultIdentity` method.
|
|
4206
|
-
#
|
|
4207
|
-
#
|
|
3570
|
+
# Response message for the `GenerateDefaultIdentity` method. This response
|
|
3571
|
+
# message is assigned to the `response` field of the returned Operation when
|
|
3572
|
+
# that operation is done.
|
|
4208
3573
|
class V1beta1GenerateDefaultIdentityResponse
|
|
4209
3574
|
include Google::Apis::Core::Hashable
|
|
4210
3575
|
|
|
@@ -4219,8 +3584,8 @@ module Google
|
|
|
4219
3584
|
# @return [Google::Apis::ServiceconsumermanagementV1beta1::V1beta1DefaultIdentity]
|
|
4220
3585
|
attr_accessor :identity
|
|
4221
3586
|
|
|
4222
|
-
# Role attached to consumer project. Empty if not attached in this
|
|
4223
|
-
#
|
|
3587
|
+
# Role attached to consumer project. Empty if not attached in this request. (
|
|
3588
|
+
# Under development, currently always return empty.)
|
|
4224
3589
|
# Corresponds to the JSON property `role`
|
|
4225
3590
|
# @return [String]
|
|
4226
3591
|
attr_accessor :role
|
|
@@ -4237,9 +3602,9 @@ module Google
|
|
|
4237
3602
|
end
|
|
4238
3603
|
end
|
|
4239
3604
|
|
|
4240
|
-
# Response message for the `GenerateServiceAccount` method.
|
|
4241
|
-
#
|
|
4242
|
-
#
|
|
3605
|
+
# Response message for the `GenerateServiceAccount` method. This response
|
|
3606
|
+
# message is assigned to the `response` field of the returned Operation when
|
|
3607
|
+
# that operation is done.
|
|
4243
3608
|
class V1beta1GenerateServiceAccountResponse
|
|
4244
3609
|
include Google::Apis::Core::Hashable
|
|
4245
3610
|
|
|
@@ -4258,9 +3623,9 @@ module Google
|
|
|
4258
3623
|
end
|
|
4259
3624
|
end
|
|
4260
3625
|
|
|
4261
|
-
# Response message for the `RefreshConsumer` method.
|
|
4262
|
-
#
|
|
4263
|
-
#
|
|
3626
|
+
# Response message for the `RefreshConsumer` method. This response message is
|
|
3627
|
+
# assigned to the `response` field of the returned Operation when that operation
|
|
3628
|
+
# is done.
|
|
4264
3629
|
class V1beta1RefreshConsumerResponse
|
|
4265
3630
|
include Google::Apis::Core::Hashable
|
|
4266
3631
|
|
|
@@ -4273,9 +3638,9 @@ module Google
|
|
|
4273
3638
|
end
|
|
4274
3639
|
end
|
|
4275
3640
|
|
|
4276
|
-
# Response message for the `RemoveVisibilityLabels` method.
|
|
4277
|
-
#
|
|
4278
|
-
#
|
|
3641
|
+
# Response message for the `RemoveVisibilityLabels` method. This response
|
|
3642
|
+
# message is assigned to the `response` field of the returned Operation when
|
|
3643
|
+
# that operation is done.
|
|
4279
3644
|
class V1beta1RemoveVisibilityLabelsResponse
|
|
4280
3645
|
include Google::Apis::Core::Hashable
|
|
4281
3646
|
|
|
@@ -4308,16 +3673,14 @@ module Google
|
|
|
4308
3673
|
# @return [String]
|
|
4309
3674
|
attr_accessor :iam_account_name
|
|
4310
3675
|
|
|
4311
|
-
# P4 SA resource name.
|
|
4312
|
-
#
|
|
4313
|
-
# `services/serviceconsumermanagement.googleapis.com/projects/123/
|
|
4314
|
-
# serviceAccounts/default`
|
|
3676
|
+
# P4 SA resource name. An example name would be: `services/
|
|
3677
|
+
# serviceconsumermanagement.googleapis.com/projects/123/serviceAccounts/default`
|
|
4315
3678
|
# Corresponds to the JSON property `name`
|
|
4316
3679
|
# @return [String]
|
|
4317
3680
|
attr_accessor :name
|
|
4318
3681
|
|
|
4319
|
-
# The P4 SA configuration tag. This must be defined in activation_grants.
|
|
4320
|
-
#
|
|
3682
|
+
# The P4 SA configuration tag. This must be defined in activation_grants. If not
|
|
3683
|
+
# specified when creating the account, the tag is set to "default".
|
|
4321
3684
|
# Corresponds to the JSON property `tag`
|
|
4322
3685
|
# @return [String]
|
|
4323
3686
|
attr_accessor :tag
|