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
|
@@ -25,7 +25,7 @@ module Google
|
|
|
25
25
|
# @see https://cloud.google.com/service-consumer-management/docs/overview
|
|
26
26
|
module ServiceconsumermanagementV1
|
|
27
27
|
VERSION = 'V1'
|
|
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,8 +22,7 @@ module Google
|
|
|
22
22
|
module Apis
|
|
23
23
|
module ServiceconsumermanagementV1
|
|
24
24
|
|
|
25
|
-
# Request to add a newly created and configured tenant project to a tenancy
|
|
26
|
-
# unit.
|
|
25
|
+
# Request to add a newly created and configured tenant project to a tenancy unit.
|
|
27
26
|
class AddTenantProjectRequest
|
|
28
27
|
include Google::Apis::Core::Hashable
|
|
29
28
|
|
|
@@ -51,14 +50,13 @@ module Google
|
|
|
51
50
|
end
|
|
52
51
|
end
|
|
53
52
|
|
|
54
|
-
# Api is a light-weight descriptor for an API Interface.
|
|
55
|
-
#
|
|
56
|
-
#
|
|
57
|
-
#
|
|
58
|
-
#
|
|
59
|
-
#
|
|
60
|
-
#
|
|
61
|
-
# detailed terminology.
|
|
53
|
+
# Api is a light-weight descriptor for an API Interface. Interfaces are also
|
|
54
|
+
# described as "protocol buffer services" in some contexts, such as by the "
|
|
55
|
+
# service" keyword in a .proto file, but they are different from API Services,
|
|
56
|
+
# which represent a concrete implementation of an interface as opposed to simply
|
|
57
|
+
# a description of methods and bindings. They are also sometimes simply referred
|
|
58
|
+
# to as "APIs" in other contexts, such as the name of this message itself. See
|
|
59
|
+
# https://cloud.google.com/apis/design/glossary for detailed terminology.
|
|
62
60
|
class Api
|
|
63
61
|
include Google::Apis::Core::Hashable
|
|
64
62
|
|
|
@@ -72,8 +70,8 @@ module Google
|
|
|
72
70
|
# @return [Array<Google::Apis::ServiceconsumermanagementV1::Mixin>]
|
|
73
71
|
attr_accessor :mixins
|
|
74
72
|
|
|
75
|
-
# The fully qualified name of this interface, including package name
|
|
76
|
-
#
|
|
73
|
+
# The fully qualified name of this interface, including package name followed by
|
|
74
|
+
# the interface's simple name.
|
|
77
75
|
# Corresponds to the JSON property `name`
|
|
78
76
|
# @return [String]
|
|
79
77
|
attr_accessor :name
|
|
@@ -83,8 +81,8 @@ module Google
|
|
|
83
81
|
# @return [Array<Google::Apis::ServiceconsumermanagementV1::Option>]
|
|
84
82
|
attr_accessor :options
|
|
85
83
|
|
|
86
|
-
# `SourceContext` represents information about the source of a
|
|
87
|
-
#
|
|
84
|
+
# `SourceContext` represents information about the source of a protobuf element,
|
|
85
|
+
# like the file in which it is defined.
|
|
88
86
|
# Corresponds to the JSON property `sourceContext`
|
|
89
87
|
# @return [Google::Apis::ServiceconsumermanagementV1::SourceContext]
|
|
90
88
|
attr_accessor :source_context
|
|
@@ -94,23 +92,19 @@ module Google
|
|
|
94
92
|
# @return [String]
|
|
95
93
|
attr_accessor :syntax
|
|
96
94
|
|
|
97
|
-
# A version string for this interface. If specified, must have the form
|
|
98
|
-
#
|
|
99
|
-
#
|
|
100
|
-
#
|
|
101
|
-
#
|
|
102
|
-
#
|
|
103
|
-
#
|
|
104
|
-
#
|
|
105
|
-
#
|
|
106
|
-
#
|
|
107
|
-
#
|
|
108
|
-
#
|
|
109
|
-
#
|
|
110
|
-
# interface, which must end in `v<major-version>`, as in
|
|
111
|
-
# `google.feature.v1`. For major versions 0 and 1, the suffix can
|
|
112
|
-
# be omitted. Zero major versions must only be used for
|
|
113
|
-
# experimental, non-GA interfaces.
|
|
95
|
+
# A version string for this interface. If specified, must have the form `major-
|
|
96
|
+
# version.minor-version`, as in `1.10`. If the minor version is omitted, it
|
|
97
|
+
# defaults to zero. If the entire version field is empty, the major version is
|
|
98
|
+
# derived from the package name, as outlined below. If the field is not empty,
|
|
99
|
+
# the version in the package name will be verified to be consistent with what is
|
|
100
|
+
# provided here. The versioning schema uses [semantic versioning](http://semver.
|
|
101
|
+
# org) where the major version number indicates a breaking change and the minor
|
|
102
|
+
# version an additive, non-breaking change. Both version numbers are signals to
|
|
103
|
+
# users what to expect from different versions, and should be carefully chosen
|
|
104
|
+
# based on the product plan. The major version is also reflected in the package
|
|
105
|
+
# name of the interface, which must end in `v`, as in `google.feature.v1`. For
|
|
106
|
+
# major versions 0 and 1, the suffix can be omitted. Zero major versions must
|
|
107
|
+
# only be used for experimental, non-GA interfaces.
|
|
114
108
|
# Corresponds to the JSON property `version`
|
|
115
109
|
# @return [String]
|
|
116
110
|
attr_accessor :version
|
|
@@ -164,22 +158,21 @@ module Google
|
|
|
164
158
|
class AttachTenantProjectRequest
|
|
165
159
|
include Google::Apis::Core::Hashable
|
|
166
160
|
|
|
167
|
-
# When attaching an external project, this is in the format of
|
|
168
|
-
#
|
|
161
|
+
# When attaching an external project, this is in the format of `projects/`
|
|
162
|
+
# project_number``.
|
|
169
163
|
# Corresponds to the JSON property `externalResource`
|
|
170
164
|
# @return [String]
|
|
171
165
|
attr_accessor :external_resource
|
|
172
166
|
|
|
173
|
-
# When attaching a reserved project already in tenancy units, this is the
|
|
174
|
-
#
|
|
175
|
-
#
|
|
176
|
-
# active state.
|
|
167
|
+
# When attaching a reserved project already in tenancy units, this is the tag of
|
|
168
|
+
# a tenant resource under the tenancy unit for the managed service's service
|
|
169
|
+
# producer project. The reserved tenant resource must be in an active state.
|
|
177
170
|
# Corresponds to the JSON property `reservedResource`
|
|
178
171
|
# @return [String]
|
|
179
172
|
attr_accessor :reserved_resource
|
|
180
173
|
|
|
181
|
-
# Tag of the tenant resource after attachment.
|
|
182
|
-
#
|
|
174
|
+
# Tag of the tenant resource after attachment. Must be less than 128 characters.
|
|
175
|
+
# Required.
|
|
183
176
|
# Corresponds to the JSON property `tag`
|
|
184
177
|
# @return [String]
|
|
185
178
|
attr_accessor :tag
|
|
@@ -196,85 +189,63 @@ module Google
|
|
|
196
189
|
end
|
|
197
190
|
end
|
|
198
191
|
|
|
199
|
-
# Configuration for an authentication provider, including support for
|
|
200
|
-
#
|
|
201
|
-
# (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).
|
|
192
|
+
# Configuration for an authentication provider, including support for [JSON Web
|
|
193
|
+
# Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).
|
|
202
194
|
class AuthProvider
|
|
203
195
|
include Google::Apis::Core::Hashable
|
|
204
196
|
|
|
205
|
-
# The list of JWT
|
|
206
|
-
#
|
|
207
|
-
#
|
|
208
|
-
#
|
|
209
|
-
# be accepted.
|
|
210
|
-
# -
|
|
211
|
-
# - "https://[service.name]/"
|
|
212
|
-
# will be accepted.
|
|
213
|
-
# For example, if no audiences are in the setting, LibraryService API will
|
|
214
|
-
# accept JWTs with the following audiences:
|
|
215
|
-
# -
|
|
197
|
+
# The list of JWT [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-
|
|
198
|
+
# web-token-32#section-4.1.3). that are allowed to access. A JWT containing any
|
|
199
|
+
# of these audiences will be accepted. When this setting is absent, JWTs with
|
|
200
|
+
# audiences: - "https://[service.name]/[google.protobuf.Api.name]" - "https://[
|
|
201
|
+
# service.name]/" will be accepted. For example, if no audiences are in the
|
|
202
|
+
# setting, LibraryService API will accept JWTs with the following audiences: -
|
|
216
203
|
# https://library-example.googleapis.com/google.example.library.v1.
|
|
217
|
-
# LibraryService
|
|
218
|
-
#
|
|
219
|
-
#
|
|
220
|
-
# audiences: bookstore_android.apps.googleusercontent.com,
|
|
221
|
-
# bookstore_web.apps.googleusercontent.com
|
|
204
|
+
# LibraryService - https://library-example.googleapis.com/ Example: audiences:
|
|
205
|
+
# bookstore_android.apps.googleusercontent.com, bookstore_web.apps.
|
|
206
|
+
# googleusercontent.com
|
|
222
207
|
# Corresponds to the JSON property `audiences`
|
|
223
208
|
# @return [String]
|
|
224
209
|
attr_accessor :audiences
|
|
225
210
|
|
|
226
|
-
# Redirect URL if JWT token is required but not present or is expired.
|
|
227
|
-
#
|
|
211
|
+
# Redirect URL if JWT token is required but not present or is expired. Implement
|
|
212
|
+
# authorizationUrl of securityDefinitions in OpenAPI spec.
|
|
228
213
|
# Corresponds to the JSON property `authorizationUrl`
|
|
229
214
|
# @return [String]
|
|
230
215
|
attr_accessor :authorization_url
|
|
231
216
|
|
|
232
|
-
# The unique identifier of the auth provider. It will be referred to by
|
|
233
|
-
#
|
|
234
|
-
# Example: "bookstore_auth".
|
|
217
|
+
# The unique identifier of the auth provider. It will be referred to by `
|
|
218
|
+
# AuthRequirement.provider_id`. Example: "bookstore_auth".
|
|
235
219
|
# Corresponds to the JSON property `id`
|
|
236
220
|
# @return [String]
|
|
237
221
|
attr_accessor :id
|
|
238
222
|
|
|
239
|
-
# Identifies the principal that issued the JWT. See
|
|
240
|
-
#
|
|
241
|
-
#
|
|
242
|
-
#
|
|
243
|
-
# Example: 1234567-compute@developer.gserviceaccount.com
|
|
223
|
+
# Identifies the principal that issued the JWT. See https://tools.ietf.org/html/
|
|
224
|
+
# draft-ietf-oauth-json-web-token-32#section-4.1.1 Usually a URL or an email
|
|
225
|
+
# address. Example: https://securetoken.google.com Example: 1234567-compute@
|
|
226
|
+
# developer.gserviceaccount.com
|
|
244
227
|
# Corresponds to the JSON property `issuer`
|
|
245
228
|
# @return [String]
|
|
246
229
|
attr_accessor :issuer
|
|
247
230
|
|
|
248
|
-
# URL of the provider's public key set to validate signature of the JWT. See
|
|
249
|
-
#
|
|
250
|
-
#
|
|
251
|
-
#
|
|
252
|
-
#
|
|
253
|
-
#
|
|
254
|
-
# [OpenID
|
|
255
|
-
# Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html of
|
|
256
|
-
# the issuer.
|
|
257
|
-
# - can be inferred from the email domain of the issuer (e.g. a Google
|
|
258
|
-
# service account).
|
|
259
|
-
# Example: https://www.googleapis.com/oauth2/v1/certs
|
|
231
|
+
# URL of the provider's public key set to validate signature of the JWT. See [
|
|
232
|
+
# OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#
|
|
233
|
+
# ProviderMetadata). Optional if the key set document: - can be retrieved from [
|
|
234
|
+
# OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html
|
|
235
|
+
# of the issuer. - can be inferred from the email domain of the issuer (e.g. a
|
|
236
|
+
# Google service account). Example: https://www.googleapis.com/oauth2/v1/certs
|
|
260
237
|
# Corresponds to the JSON property `jwksUri`
|
|
261
238
|
# @return [String]
|
|
262
239
|
attr_accessor :jwks_uri
|
|
263
240
|
|
|
264
|
-
# Defines the locations to extract the JWT.
|
|
265
|
-
#
|
|
266
|
-
# The
|
|
267
|
-
#
|
|
268
|
-
#
|
|
269
|
-
#
|
|
270
|
-
#
|
|
271
|
-
#
|
|
272
|
-
# Default locations can be specified as followings:
|
|
273
|
-
# jwt_locations:
|
|
274
|
-
# - header: Authorization
|
|
275
|
-
# value_prefix: "Bearer "
|
|
276
|
-
# - header: x-goog-iap-jwt-assertion
|
|
277
|
-
# - query: access_token
|
|
241
|
+
# Defines the locations to extract the JWT. JWT locations can be either from
|
|
242
|
+
# HTTP headers or URL query parameters. The rule is that the first match wins.
|
|
243
|
+
# The checking order is: checking all headers first, then URL query parameters.
|
|
244
|
+
# If not specified, default to use following 3 locations: 1) Authorization:
|
|
245
|
+
# Bearer 2) x-goog-iap-jwt-assertion 3) access_token query parameter Default
|
|
246
|
+
# locations can be specified as followings: jwt_locations: - header:
|
|
247
|
+
# Authorization value_prefix: "Bearer " - header: x-goog-iap-jwt-assertion -
|
|
248
|
+
# query: access_token
|
|
278
249
|
# Corresponds to the JSON property `jwtLocations`
|
|
279
250
|
# @return [Array<Google::Apis::ServiceconsumermanagementV1::JwtLocation>]
|
|
280
251
|
attr_accessor :jwt_locations
|
|
@@ -294,34 +265,26 @@ module Google
|
|
|
294
265
|
end
|
|
295
266
|
end
|
|
296
267
|
|
|
297
|
-
# User-defined authentication requirements, including support for
|
|
298
|
-
#
|
|
299
|
-
# (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).
|
|
268
|
+
# User-defined authentication requirements, including support for [JSON Web
|
|
269
|
+
# Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).
|
|
300
270
|
class AuthRequirement
|
|
301
271
|
include Google::Apis::Core::Hashable
|
|
302
272
|
|
|
303
|
-
# NOTE: This will be deprecated soon, once AuthProvider.audiences is
|
|
304
|
-
#
|
|
305
|
-
#
|
|
306
|
-
#
|
|
307
|
-
#
|
|
308
|
-
#
|
|
309
|
-
#
|
|
310
|
-
# "https://
|
|
311
|
-
#
|
|
312
|
-
#
|
|
313
|
-
# "https://library-example.googleapis.com/google.example.library.v1.
|
|
314
|
-
# LibraryService".
|
|
315
|
-
# Example:
|
|
316
|
-
# audiences: bookstore_android.apps.googleusercontent.com,
|
|
317
|
-
# bookstore_web.apps.googleusercontent.com
|
|
273
|
+
# NOTE: This will be deprecated soon, once AuthProvider.audiences is implemented
|
|
274
|
+
# and accepted in all the runtime components. The list of JWT [audiences](https:/
|
|
275
|
+
# /tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). that
|
|
276
|
+
# are allowed to access. A JWT containing any of these audiences will be
|
|
277
|
+
# accepted. When this setting is absent, only JWTs with audience "https://
|
|
278
|
+
# Service_name/API_name" will be accepted. For example, if no audiences are in
|
|
279
|
+
# the setting, LibraryService API will only accept JWTs with the following
|
|
280
|
+
# audience "https://library-example.googleapis.com/google.example.library.v1.
|
|
281
|
+
# LibraryService". Example: audiences: bookstore_android.apps.googleusercontent.
|
|
282
|
+
# com, bookstore_web.apps.googleusercontent.com
|
|
318
283
|
# Corresponds to the JSON property `audiences`
|
|
319
284
|
# @return [String]
|
|
320
285
|
attr_accessor :audiences
|
|
321
286
|
|
|
322
|
-
# id from authentication provider.
|
|
323
|
-
# Example:
|
|
324
|
-
# provider_id: bookstore_auth
|
|
287
|
+
# id from authentication provider. Example: provider_id: bookstore_auth
|
|
325
288
|
# Corresponds to the JSON property `providerId`
|
|
326
289
|
# @return [String]
|
|
327
290
|
attr_accessor :provider_id
|
|
@@ -337,18 +300,11 @@ module Google
|
|
|
337
300
|
end
|
|
338
301
|
end
|
|
339
302
|
|
|
340
|
-
# `Authentication` defines the authentication configuration for an API.
|
|
341
|
-
#
|
|
342
|
-
#
|
|
343
|
-
#
|
|
344
|
-
#
|
|
345
|
-
# - id: google_calendar_auth
|
|
346
|
-
# jwks_uri: https://www.googleapis.com/oauth2/v1/certs
|
|
347
|
-
# issuer: https://securetoken.google.com
|
|
348
|
-
# rules:
|
|
349
|
-
# - selector: "*"
|
|
350
|
-
# requirements:
|
|
351
|
-
# provider_id: google_calendar_auth
|
|
303
|
+
# `Authentication` defines the authentication configuration for an API. Example
|
|
304
|
+
# for an API targeted for external use: name: calendar.googleapis.com
|
|
305
|
+
# authentication: providers: - id: google_calendar_auth jwks_uri: https://www.
|
|
306
|
+
# googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: -
|
|
307
|
+
# selector: "*" requirements: provider_id: google_calendar_auth
|
|
352
308
|
class Authentication
|
|
353
309
|
include Google::Apis::Core::Hashable
|
|
354
310
|
|
|
@@ -357,8 +313,8 @@ module Google
|
|
|
357
313
|
# @return [Array<Google::Apis::ServiceconsumermanagementV1::AuthProvider>]
|
|
358
314
|
attr_accessor :providers
|
|
359
315
|
|
|
360
|
-
# A list of authentication rules that apply to individual API methods.
|
|
361
|
-
#
|
|
316
|
+
# A list of authentication rules that apply to individual API methods. **NOTE:**
|
|
317
|
+
# All service configuration rules follow "last one wins" order.
|
|
362
318
|
# Corresponds to the JSON property `rules`
|
|
363
319
|
# @return [Array<Google::Apis::ServiceconsumermanagementV1::AuthenticationRule>]
|
|
364
320
|
attr_accessor :rules
|
|
@@ -374,13 +330,11 @@ module Google
|
|
|
374
330
|
end
|
|
375
331
|
end
|
|
376
332
|
|
|
377
|
-
# Authentication rules for the service.
|
|
378
|
-
#
|
|
379
|
-
#
|
|
380
|
-
#
|
|
381
|
-
# request.
|
|
382
|
-
# If a method doesn't have any auth requirements, request credentials will be
|
|
383
|
-
# ignored.
|
|
333
|
+
# Authentication rules for the service. By default, if a method has any
|
|
334
|
+
# authentication requirements, every request must include a valid credential
|
|
335
|
+
# matching one of the requirements. It's an error to include more than one kind
|
|
336
|
+
# of credential in a single request. If a method doesn't have any auth
|
|
337
|
+
# requirements, request credentials will be ignored.
|
|
384
338
|
class AuthenticationRule
|
|
385
339
|
include Google::Apis::Core::Hashable
|
|
386
340
|
|
|
@@ -391,19 +345,18 @@ module Google
|
|
|
391
345
|
alias_method :allow_without_credential?, :allow_without_credential
|
|
392
346
|
|
|
393
347
|
# OAuth scopes are a way to define data and permissions on data. For example,
|
|
394
|
-
# there are scopes defined for "Read-only access to Google Calendar" and
|
|
395
|
-
#
|
|
396
|
-
#
|
|
397
|
-
#
|
|
398
|
-
#
|
|
399
|
-
#
|
|
400
|
-
#
|
|
401
|
-
#
|
|
402
|
-
#
|
|
403
|
-
#
|
|
404
|
-
#
|
|
405
|
-
#
|
|
406
|
-
# due to the backend requiring additional scopes or permissions.
|
|
348
|
+
# there are scopes defined for "Read-only access to Google Calendar" and "Access
|
|
349
|
+
# to Cloud Platform". Users can consent to a scope for an application, giving it
|
|
350
|
+
# permission to access that data on their behalf. OAuth scope specifications
|
|
351
|
+
# should be fairly coarse grained; a user will need to see and understand the
|
|
352
|
+
# text description of what your scope means. In most cases: use one or at most
|
|
353
|
+
# two OAuth scopes for an entire family of products. If your product has
|
|
354
|
+
# multiple APIs, you should probably be sharing the OAuth scope across all of
|
|
355
|
+
# those APIs. When you need finer grained OAuth consent screens: talk with your
|
|
356
|
+
# product management about how developers will use them in practice. Please note
|
|
357
|
+
# that even though each of the canonical scopes is enough for a request to be
|
|
358
|
+
# accepted and passed to the backend, a request can still fail due to the
|
|
359
|
+
# backend requiring additional scopes or permissions.
|
|
407
360
|
# Corresponds to the JSON property `oauth`
|
|
408
361
|
# @return [Google::Apis::ServiceconsumermanagementV1::OAuthRequirements]
|
|
409
362
|
attr_accessor :oauth
|
|
@@ -413,8 +366,8 @@ module Google
|
|
|
413
366
|
# @return [Array<Google::Apis::ServiceconsumermanagementV1::AuthRequirement>]
|
|
414
367
|
attr_accessor :requirements
|
|
415
368
|
|
|
416
|
-
# Selects the methods to which this rule applies.
|
|
417
|
-
#
|
|
369
|
+
# Selects the methods to which this rule applies. Refer to selector for syntax
|
|
370
|
+
# details.
|
|
418
371
|
# Corresponds to the JSON property `selector`
|
|
419
372
|
# @return [String]
|
|
420
373
|
attr_accessor :selector
|
|
@@ -436,8 +389,8 @@ module Google
|
|
|
436
389
|
class Backend
|
|
437
390
|
include Google::Apis::Core::Hashable
|
|
438
391
|
|
|
439
|
-
# A list of API backend rules that apply to individual API methods.
|
|
440
|
-
#
|
|
392
|
+
# A list of API backend rules that apply to individual API methods. **NOTE:**
|
|
393
|
+
# All service configuration rules follow "last one wins" order.
|
|
441
394
|
# Corresponds to the JSON property `rules`
|
|
442
395
|
# @return [Array<Google::Apis::ServiceconsumermanagementV1::BackendRule>]
|
|
443
396
|
attr_accessor :rules
|
|
@@ -456,21 +409,13 @@ module Google
|
|
|
456
409
|
class BackendRule
|
|
457
410
|
include Google::Apis::Core::Hashable
|
|
458
411
|
|
|
459
|
-
# The address of the API backend.
|
|
460
|
-
#
|
|
461
|
-
#
|
|
462
|
-
#
|
|
463
|
-
#
|
|
464
|
-
#
|
|
465
|
-
#
|
|
466
|
-
# grpcs:// gRPC TLS
|
|
467
|
-
# It is recommended to explicitly include a scheme. Leaving out the scheme
|
|
468
|
-
# may cause constrasting behaviors across platforms.
|
|
469
|
-
# If the port is unspecified, the default is:
|
|
470
|
-
# - 80 for schemes without TLS
|
|
471
|
-
# - 443 for schemes with TLS
|
|
472
|
-
# For HTTP backends, use protocol
|
|
473
|
-
# to specify the protocol version.
|
|
412
|
+
# The address of the API backend. The scheme is used to determine the backend
|
|
413
|
+
# protocol and security. The following schemes are accepted: SCHEME PROTOCOL
|
|
414
|
+
# SECURITY http:// HTTP None https:// HTTP TLS grpc:// gRPC None grpcs:// gRPC
|
|
415
|
+
# TLS It is recommended to explicitly include a scheme. Leaving out the scheme
|
|
416
|
+
# may cause constrasting behaviors across platforms. If the port is unspecified,
|
|
417
|
+
# the default is: - 80 for schemes without TLS - 443 for schemes with TLS For
|
|
418
|
+
# HTTP backends, use protocol to specify the protocol version.
|
|
474
419
|
# Corresponds to the JSON property `address`
|
|
475
420
|
# @return [String]
|
|
476
421
|
attr_accessor :address
|
|
@@ -481,18 +426,18 @@ module Google
|
|
|
481
426
|
# @return [Float]
|
|
482
427
|
attr_accessor :deadline
|
|
483
428
|
|
|
484
|
-
# When disable_auth is true, a JWT ID token won't be generated and the
|
|
485
|
-
#
|
|
486
|
-
#
|
|
487
|
-
#
|
|
429
|
+
# When disable_auth is true, a JWT ID token won't be generated and the original "
|
|
430
|
+
# Authorization" HTTP header will be preserved. If the header is used to carry
|
|
431
|
+
# the original token and is expected by the backend, this field must be set to
|
|
432
|
+
# true to preserve the header.
|
|
488
433
|
# Corresponds to the JSON property `disableAuth`
|
|
489
434
|
# @return [Boolean]
|
|
490
435
|
attr_accessor :disable_auth
|
|
491
436
|
alias_method :disable_auth?, :disable_auth
|
|
492
437
|
|
|
493
|
-
# The JWT audience is used when generating a JWT ID token for the backend.
|
|
494
|
-
#
|
|
495
|
-
#
|
|
438
|
+
# The JWT audience is used when generating a JWT ID token for the backend. This
|
|
439
|
+
# ID token will be added in the HTTP "authorization" header, and sent to the
|
|
440
|
+
# backend.
|
|
496
441
|
# Corresponds to the JSON property `jwtAudience`
|
|
497
442
|
# @return [String]
|
|
498
443
|
attr_accessor :jwt_audience
|
|
@@ -503,8 +448,8 @@ module Google
|
|
|
503
448
|
# @return [Float]
|
|
504
449
|
attr_accessor :min_deadline
|
|
505
450
|
|
|
506
|
-
# The number of seconds to wait for the completion of a long running
|
|
507
|
-
#
|
|
451
|
+
# The number of seconds to wait for the completion of a long running operation.
|
|
452
|
+
# The default is no deadline.
|
|
508
453
|
# Corresponds to the JSON property `operationDeadline`
|
|
509
454
|
# @return [Float]
|
|
510
455
|
attr_accessor :operation_deadline
|
|
@@ -514,29 +459,21 @@ module Google
|
|
|
514
459
|
# @return [String]
|
|
515
460
|
attr_accessor :path_translation
|
|
516
461
|
|
|
517
|
-
# The protocol used for sending a request to the backend.
|
|
518
|
-
#
|
|
519
|
-
#
|
|
520
|
-
#
|
|
521
|
-
#
|
|
522
|
-
#
|
|
523
|
-
# https://
|
|
524
|
-
#
|
|
525
|
-
#
|
|
526
|
-
# For secure HTTP backends (https://) that support HTTP/2, set this field
|
|
527
|
-
# to "h2" for improved performance.
|
|
528
|
-
# Configuring this field to non-default values is only supported for secure
|
|
529
|
-
# HTTP backends. This field will be ignored for all other backends.
|
|
530
|
-
# See
|
|
531
|
-
# https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-
|
|
532
|
-
# values.xhtml#alpn-protocol-ids
|
|
533
|
-
# for more details on the supported values.
|
|
462
|
+
# The protocol used for sending a request to the backend. The supported values
|
|
463
|
+
# are "http/1.1" and "h2". The default value is inferred from the scheme in the
|
|
464
|
+
# address field: SCHEME PROTOCOL http:// http/1.1 https:// http/1.1 grpc:// h2
|
|
465
|
+
# grpcs:// h2 For secure HTTP backends (https://) that support HTTP/2, set this
|
|
466
|
+
# field to "h2" for improved performance. Configuring this field to non-default
|
|
467
|
+
# values is only supported for secure HTTP backends. This field will be ignored
|
|
468
|
+
# for all other backends. See https://www.iana.org/assignments/tls-extensiontype-
|
|
469
|
+
# values/tls-extensiontype-values.xhtml#alpn-protocol-ids for more details on
|
|
470
|
+
# the supported values.
|
|
534
471
|
# Corresponds to the JSON property `protocol`
|
|
535
472
|
# @return [String]
|
|
536
473
|
attr_accessor :protocol
|
|
537
474
|
|
|
538
|
-
# Selects the methods to which this rule applies.
|
|
539
|
-
#
|
|
475
|
+
# Selects the methods to which this rule applies. Refer to selector for syntax
|
|
476
|
+
# details.
|
|
540
477
|
# Corresponds to the JSON property `selector`
|
|
541
478
|
# @return [String]
|
|
542
479
|
attr_accessor :selector
|
|
@@ -559,42 +496,28 @@ module Google
|
|
|
559
496
|
end
|
|
560
497
|
end
|
|
561
498
|
|
|
562
|
-
# Billing related configuration of the service.
|
|
563
|
-
#
|
|
564
|
-
#
|
|
565
|
-
#
|
|
566
|
-
#
|
|
567
|
-
#
|
|
568
|
-
#
|
|
569
|
-
#
|
|
570
|
-
# -
|
|
571
|
-
#
|
|
572
|
-
# - key:
|
|
573
|
-
#
|
|
574
|
-
#
|
|
575
|
-
# -
|
|
576
|
-
#
|
|
577
|
-
# Custom label to define the city where the library branch is located
|
|
578
|
-
# in.
|
|
579
|
-
# - key: name
|
|
580
|
-
# description: Custom label to define the name of the library branch.
|
|
581
|
-
# metrics:
|
|
582
|
-
# - name: library.googleapis.com/book/borrowed_count
|
|
583
|
-
# metric_kind: DELTA
|
|
584
|
-
# value_type: INT64
|
|
585
|
-
# unit: "1"
|
|
586
|
-
# billing:
|
|
587
|
-
# consumer_destinations:
|
|
588
|
-
# - monitored_resource: library.googleapis.com/billing_branch
|
|
589
|
-
# metrics:
|
|
590
|
-
# - library.googleapis.com/book/borrowed_count
|
|
499
|
+
# Billing related configuration of the service. The following example shows how
|
|
500
|
+
# to configure monitored resources and metrics for billing, `
|
|
501
|
+
# consumer_destinations` is the only supported destination and the monitored
|
|
502
|
+
# resources need at least one label key `cloud.googleapis.com/location` to
|
|
503
|
+
# indicate the location of the billing usage, using different monitored
|
|
504
|
+
# resources between monitoring and billing is recommended so they can be evolved
|
|
505
|
+
# independently: monitored_resources: - type: library.googleapis.com/
|
|
506
|
+
# billing_branch labels: - key: cloud.googleapis.com/location description: |
|
|
507
|
+
# Predefined label to support billing location restriction. - key: city
|
|
508
|
+
# description: | Custom label to define the city where the library branch is
|
|
509
|
+
# located in. - key: name description: Custom label to define the name of the
|
|
510
|
+
# library branch. metrics: - name: library.googleapis.com/book/borrowed_count
|
|
511
|
+
# metric_kind: DELTA value_type: INT64 unit: "1" billing: consumer_destinations:
|
|
512
|
+
# - monitored_resource: library.googleapis.com/billing_branch metrics: - library.
|
|
513
|
+
# googleapis.com/book/borrowed_count
|
|
591
514
|
class Billing
|
|
592
515
|
include Google::Apis::Core::Hashable
|
|
593
516
|
|
|
594
|
-
# Billing configurations for sending metrics to the consumer project.
|
|
595
|
-
#
|
|
596
|
-
#
|
|
597
|
-
#
|
|
517
|
+
# Billing configurations for sending metrics to the consumer project. There can
|
|
518
|
+
# be multiple consumer destinations per service, each one must have a different
|
|
519
|
+
# monitored resource type. A metric can be used in at most one consumer
|
|
520
|
+
# destination.
|
|
598
521
|
# Corresponds to the JSON property `consumerDestinations`
|
|
599
522
|
# @return [Array<Google::Apis::ServiceconsumermanagementV1::BillingDestination>]
|
|
600
523
|
attr_accessor :consumer_destinations
|
|
@@ -613,8 +536,8 @@ module Google
|
|
|
613
536
|
class BillingConfig
|
|
614
537
|
include Google::Apis::Core::Hashable
|
|
615
538
|
|
|
616
|
-
# Name of the billing account.
|
|
617
|
-
#
|
|
539
|
+
# Name of the billing account. For example `billingAccounts/012345-567890-ABCDEF`
|
|
540
|
+
# .
|
|
618
541
|
# Corresponds to the JSON property `billingAccount`
|
|
619
542
|
# @return [String]
|
|
620
543
|
attr_accessor :billing_account
|
|
@@ -629,19 +552,19 @@ module Google
|
|
|
629
552
|
end
|
|
630
553
|
end
|
|
631
554
|
|
|
632
|
-
# Configuration of a specific billing destination (Currently only support
|
|
633
|
-
#
|
|
555
|
+
# Configuration of a specific billing destination (Currently only support bill
|
|
556
|
+
# against consumer project).
|
|
634
557
|
class BillingDestination
|
|
635
558
|
include Google::Apis::Core::Hashable
|
|
636
559
|
|
|
637
|
-
# Names of the metrics to report to this billing destination.
|
|
638
|
-
#
|
|
560
|
+
# Names of the metrics to report to this billing destination. Each name must be
|
|
561
|
+
# defined in Service.metrics section.
|
|
639
562
|
# Corresponds to the JSON property `metrics`
|
|
640
563
|
# @return [Array<String>]
|
|
641
564
|
attr_accessor :metrics
|
|
642
565
|
|
|
643
|
-
# The monitored resource type. The type must be defined in
|
|
644
|
-
#
|
|
566
|
+
# The monitored resource type. The type must be defined in Service.
|
|
567
|
+
# monitored_resources section.
|
|
645
568
|
# Corresponds to the JSON property `monitoredResource`
|
|
646
569
|
# @return [String]
|
|
647
570
|
attr_accessor :monitored_resource
|
|
@@ -670,39 +593,24 @@ module Google
|
|
|
670
593
|
end
|
|
671
594
|
end
|
|
672
595
|
|
|
673
|
-
# `Context` defines which contexts an API requests.
|
|
674
|
-
#
|
|
675
|
-
# context
|
|
676
|
-
#
|
|
677
|
-
#
|
|
678
|
-
#
|
|
679
|
-
# -
|
|
680
|
-
#
|
|
681
|
-
#
|
|
682
|
-
#
|
|
683
|
-
#
|
|
684
|
-
#
|
|
685
|
-
#
|
|
686
|
-
# This also provides mechanism to whitelist any protobuf message extension that
|
|
687
|
-
# can be sent in grpc metadata using “x-goog-ext-<extension_id>-bin” and
|
|
688
|
-
# “x-goog-ext-<extension_id>-jspb” format. For example, list any service
|
|
689
|
-
# specific protobuf types that can appear in grpc metadata as follows in your
|
|
690
|
-
# yaml file:
|
|
691
|
-
# Example:
|
|
692
|
-
# context:
|
|
693
|
-
# rules:
|
|
694
|
-
# - selector: "google.example.library.v1.LibraryService.CreateBook"
|
|
695
|
-
# allowed_request_extensions:
|
|
696
|
-
# - google.foo.v1.NewExtension
|
|
697
|
-
# allowed_response_extensions:
|
|
698
|
-
# - google.foo.v1.NewExtension
|
|
699
|
-
# You can also specify extension ID instead of fully qualified extension name
|
|
700
|
-
# here.
|
|
596
|
+
# `Context` defines which contexts an API requests. Example: context: rules: -
|
|
597
|
+
# selector: "*" requested: - google.rpc.context.ProjectContext - google.rpc.
|
|
598
|
+
# context.OriginContext The above specifies that all methods in the API request `
|
|
599
|
+
# google.rpc.context.ProjectContext` and `google.rpc.context.OriginContext`.
|
|
600
|
+
# Available context types are defined in package `google.rpc.context`. This also
|
|
601
|
+
# provides mechanism to whitelist any protobuf message extension that can be
|
|
602
|
+
# sent in grpc metadata using “x-goog-ext--bin” and “x-goog-ext--jspb” format.
|
|
603
|
+
# For example, list any service specific protobuf types that can appear in grpc
|
|
604
|
+
# metadata as follows in your yaml file: Example: context: rules: - selector: "
|
|
605
|
+
# google.example.library.v1.LibraryService.CreateBook"
|
|
606
|
+
# allowed_request_extensions: - google.foo.v1.NewExtension
|
|
607
|
+
# allowed_response_extensions: - google.foo.v1.NewExtension You can also specify
|
|
608
|
+
# extension ID instead of fully qualified extension name here.
|
|
701
609
|
class Context
|
|
702
610
|
include Google::Apis::Core::Hashable
|
|
703
611
|
|
|
704
|
-
# A list of RPC context rules that apply to individual API methods.
|
|
705
|
-
#
|
|
612
|
+
# A list of RPC context rules that apply to individual API methods. **NOTE:**
|
|
613
|
+
# All service configuration rules follow "last one wins" order.
|
|
706
614
|
# Corresponds to the JSON property `rules`
|
|
707
615
|
# @return [Array<Google::Apis::ServiceconsumermanagementV1::ContextRule>]
|
|
708
616
|
attr_accessor :rules
|
|
@@ -722,14 +630,14 @@ module Google
|
|
|
722
630
|
class ContextRule
|
|
723
631
|
include Google::Apis::Core::Hashable
|
|
724
632
|
|
|
725
|
-
# A list of full type names or extension IDs of extensions allowed in grpc
|
|
726
|
-
#
|
|
633
|
+
# A list of full type names or extension IDs of extensions allowed in grpc side
|
|
634
|
+
# channel from client to backend.
|
|
727
635
|
# Corresponds to the JSON property `allowedRequestExtensions`
|
|
728
636
|
# @return [Array<String>]
|
|
729
637
|
attr_accessor :allowed_request_extensions
|
|
730
638
|
|
|
731
|
-
# A list of full type names or extension IDs of extensions allowed in grpc
|
|
732
|
-
#
|
|
639
|
+
# A list of full type names or extension IDs of extensions allowed in grpc side
|
|
640
|
+
# channel from backend to client.
|
|
733
641
|
# Corresponds to the JSON property `allowedResponseExtensions`
|
|
734
642
|
# @return [Array<String>]
|
|
735
643
|
attr_accessor :allowed_response_extensions
|
|
@@ -744,8 +652,8 @@ module Google
|
|
|
744
652
|
# @return [Array<String>]
|
|
745
653
|
attr_accessor :requested
|
|
746
654
|
|
|
747
|
-
# Selects the methods to which this rule applies.
|
|
748
|
-
#
|
|
655
|
+
# Selects the methods to which this rule applies. Refer to selector for syntax
|
|
656
|
+
# details.
|
|
749
657
|
# Corresponds to the JSON property `selector`
|
|
750
658
|
# @return [String]
|
|
751
659
|
attr_accessor :selector
|
|
@@ -764,14 +672,14 @@ module Google
|
|
|
764
672
|
end
|
|
765
673
|
end
|
|
766
674
|
|
|
767
|
-
# Selects and configures the service controller used by the service.
|
|
768
|
-
#
|
|
769
|
-
#
|
|
675
|
+
# Selects and configures the service controller used by the service. The service
|
|
676
|
+
# controller handles features like abuse, quota, billing, logging, monitoring,
|
|
677
|
+
# etc.
|
|
770
678
|
class Control
|
|
771
679
|
include Google::Apis::Core::Hashable
|
|
772
680
|
|
|
773
|
-
# The service control environment to use. If empty, no control plane
|
|
774
|
-
#
|
|
681
|
+
# The service control environment to use. If empty, no control plane feature (
|
|
682
|
+
# like quota and billing) will be enabled.
|
|
775
683
|
# Corresponds to the JSON property `environment`
|
|
776
684
|
# @return [String]
|
|
777
685
|
attr_accessor :environment
|
|
@@ -791,13 +699,12 @@ module Google
|
|
|
791
699
|
include Google::Apis::Core::Hashable
|
|
792
700
|
|
|
793
701
|
# Optional. Optional service producer-provided identifier of the tenancy unit.
|
|
794
|
-
# Must be no longer than 40 characters and preferably URI friendly.
|
|
795
|
-
#
|
|
796
|
-
#
|
|
797
|
-
#
|
|
798
|
-
#
|
|
799
|
-
#
|
|
800
|
-
# fails.
|
|
702
|
+
# Must be no longer than 40 characters and preferably URI friendly. If it isn't
|
|
703
|
+
# provided, a UID for the tenancy unit is automatically generated. The
|
|
704
|
+
# identifier must be unique across a managed service. If the tenancy unit
|
|
705
|
+
# already exists for the managed service and service consumer pair, calling `
|
|
706
|
+
# CreateTenancyUnit` returns the existing tenancy unit if the provided
|
|
707
|
+
# identifier is identical or empty, otherwise the call fails.
|
|
801
708
|
# Corresponds to the JSON property `tenancyUnitId`
|
|
802
709
|
# @return [String]
|
|
803
710
|
attr_accessor :tenancy_unit_id
|
|
@@ -812,19 +719,15 @@ module Google
|
|
|
812
719
|
end
|
|
813
720
|
end
|
|
814
721
|
|
|
815
|
-
# Customize service error responses.
|
|
816
|
-
#
|
|
817
|
-
#
|
|
818
|
-
#
|
|
819
|
-
# custom_error:
|
|
820
|
-
# types:
|
|
821
|
-
# - google.foo.v1.CustomError
|
|
822
|
-
# - google.foo.v1.AnotherError
|
|
722
|
+
# Customize service error responses. For example, list any service specific
|
|
723
|
+
# protobuf types that can appear in error detail lists of error responses.
|
|
724
|
+
# Example: custom_error: types: - google.foo.v1.CustomError - google.foo.v1.
|
|
725
|
+
# AnotherError
|
|
823
726
|
class CustomError
|
|
824
727
|
include Google::Apis::Core::Hashable
|
|
825
728
|
|
|
826
|
-
# The list of custom error rules that apply to individual API messages.
|
|
827
|
-
#
|
|
729
|
+
# The list of custom error rules that apply to individual API messages. **NOTE:**
|
|
730
|
+
# All service configuration rules follow "last one wins" order.
|
|
828
731
|
# Corresponds to the JSON property `rules`
|
|
829
732
|
# @return [Array<Google::Apis::ServiceconsumermanagementV1::CustomErrorRule>]
|
|
830
733
|
attr_accessor :rules
|
|
@@ -849,15 +752,15 @@ module Google
|
|
|
849
752
|
class CustomErrorRule
|
|
850
753
|
include Google::Apis::Core::Hashable
|
|
851
754
|
|
|
852
|
-
# Mark this message as possible payload in error response.
|
|
853
|
-
#
|
|
755
|
+
# Mark this message as possible payload in error response. Otherwise, objects of
|
|
756
|
+
# this type will be filtered when they appear in error payload.
|
|
854
757
|
# Corresponds to the JSON property `isErrorType`
|
|
855
758
|
# @return [Boolean]
|
|
856
759
|
attr_accessor :is_error_type
|
|
857
760
|
alias_method :is_error_type?, :is_error_type
|
|
858
761
|
|
|
859
|
-
# Selects messages to which this rule applies.
|
|
860
|
-
#
|
|
762
|
+
# Selects messages to which this rule applies. Refer to selector for syntax
|
|
763
|
+
# details.
|
|
861
764
|
# Corresponds to the JSON property `selector`
|
|
862
765
|
# @return [String]
|
|
863
766
|
attr_accessor :selector
|
|
@@ -917,56 +820,32 @@ module Google
|
|
|
917
820
|
end
|
|
918
821
|
end
|
|
919
822
|
|
|
920
|
-
# `Documentation` provides the information for describing a service.
|
|
921
|
-
#
|
|
922
|
-
#
|
|
923
|
-
#
|
|
924
|
-
#
|
|
925
|
-
#
|
|
926
|
-
#
|
|
927
|
-
#
|
|
928
|
-
#
|
|
929
|
-
#
|
|
930
|
-
#
|
|
931
|
-
#
|
|
932
|
-
#
|
|
933
|
-
#
|
|
934
|
-
#
|
|
935
|
-
#
|
|
936
|
-
#
|
|
937
|
-
#
|
|
938
|
-
#
|
|
939
|
-
#
|
|
940
|
-
#
|
|
941
|
-
#
|
|
942
|
-
#
|
|
943
|
-
#
|
|
944
|
-
#
|
|
945
|
-
#
|
|
946
|
-
# a documentation fragment is embedded.
|
|
947
|
-
# Documentation from the IDL is merged with documentation defined
|
|
948
|
-
# via the config at normalization time, where documentation provided
|
|
949
|
-
# by config rules overrides IDL provided.
|
|
950
|
-
# A number of constructs specific to the API platform are supported
|
|
951
|
-
# in documentation text.
|
|
952
|
-
# In order to reference a proto element, the following
|
|
953
|
-
# notation can be used:
|
|
954
|
-
# <pre><code>[fully.qualified.proto.name][]</code></pre>
|
|
955
|
-
# To override the display text used for the link, this can be used:
|
|
956
|
-
# <pre><code>[display text][fully.qualified.proto.name]</code></pre>
|
|
957
|
-
# Text can be excluded from doc using the following notation:
|
|
958
|
-
# <pre><code>(-- internal comment --)</code></pre>
|
|
959
|
-
# A few directives are available in documentation. Note that
|
|
960
|
-
# directives must appear on a single line to be properly
|
|
961
|
-
# identified. The `include` directive includes a markdown file from
|
|
962
|
-
# an external source:
|
|
963
|
-
# <pre><code>(== include path/to/file ==)</code></pre>
|
|
964
|
-
# The `resource_for` directive marks a message to be the resource of
|
|
965
|
-
# a collection in REST view. If it is not specified, tools attempt
|
|
966
|
-
# to infer the resource from the operations in a collection:
|
|
967
|
-
# <pre><code>(== resource_for v1.shelves.books ==)</code></pre>
|
|
968
|
-
# The directive `suppress_warning` does not directly affect documentation
|
|
969
|
-
# and is documented together with service config validation.
|
|
823
|
+
# `Documentation` provides the information for describing a service. Example:
|
|
824
|
+
# documentation: summary: > The Google Calendar API gives access to most
|
|
825
|
+
# calendar features. pages: - name: Overview content: (== include google/foo/
|
|
826
|
+
# overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==
|
|
827
|
+
# ) subpages; - name: Java content: (== include google/foo/tutorial_java.md ==)
|
|
828
|
+
# rules: - selector: google.calendar.Calendar.Get description: > ... - selector:
|
|
829
|
+
# google.calendar.Calendar.Put description: > ... Documentation is provided in
|
|
830
|
+
# markdown syntax. In addition to standard markdown features, definition lists,
|
|
831
|
+
# tables and fenced code blocks are supported. Section headers can be provided
|
|
832
|
+
# and are interpreted relative to the section nesting of the context where a
|
|
833
|
+
# documentation fragment is embedded. Documentation from the IDL is merged with
|
|
834
|
+
# documentation defined via the config at normalization time, where
|
|
835
|
+
# documentation provided by config rules overrides IDL provided. A number of
|
|
836
|
+
# constructs specific to the API platform are supported in documentation text.
|
|
837
|
+
# In order to reference a proto element, the following notation can be used: [
|
|
838
|
+
# fully.qualified.proto.name][] To override the display text used for the link,
|
|
839
|
+
# this can be used: [display text][fully.qualified.proto.name] Text can be
|
|
840
|
+
# excluded from doc using the following notation: (-- internal comment --) A few
|
|
841
|
+
# directives are available in documentation. Note that directives must appear on
|
|
842
|
+
# a single line to be properly identified. The `include` directive includes a
|
|
843
|
+
# markdown file from an external source: (== include path/to/file ==) The `
|
|
844
|
+
# resource_for` directive marks a message to be the resource of a collection in
|
|
845
|
+
# REST view. If it is not specified, tools attempt to infer the resource from
|
|
846
|
+
# the operations in a collection: (== resource_for v1.shelves.books ==) The
|
|
847
|
+
# directive `suppress_warning` does not directly affect documentation and is
|
|
848
|
+
# documented together with service config validation.
|
|
970
849
|
class Documentation
|
|
971
850
|
include Google::Apis::Core::Hashable
|
|
972
851
|
|
|
@@ -975,19 +854,11 @@ module Google
|
|
|
975
854
|
# @return [String]
|
|
976
855
|
attr_accessor :documentation_root_url
|
|
977
856
|
|
|
978
|
-
# Declares a single overview page. For example:
|
|
979
|
-
#
|
|
980
|
-
# summary: ...
|
|
981
|
-
#
|
|
982
|
-
#
|
|
983
|
-
# This is a shortcut for the following declaration (using pages style):
|
|
984
|
-
# <pre><code>documentation:
|
|
985
|
-
# summary: ...
|
|
986
|
-
# pages:
|
|
987
|
-
# - name: Overview
|
|
988
|
-
# content: (== include overview.md ==)
|
|
989
|
-
# </code></pre>
|
|
990
|
-
# Note: you cannot specify both `overview` field and `pages` field.
|
|
857
|
+
# Declares a single overview page. For example: documentation: summary: ...
|
|
858
|
+
# overview: (== include overview.md ==) This is a shortcut for the following
|
|
859
|
+
# declaration (using pages style): documentation: summary: ... pages: - name:
|
|
860
|
+
# Overview content: (== include overview.md ==) Note: you cannot specify both `
|
|
861
|
+
# overview` field and `pages` field.
|
|
991
862
|
# Corresponds to the JSON property `overview`
|
|
992
863
|
# @return [String]
|
|
993
864
|
attr_accessor :overview
|
|
@@ -997,22 +868,20 @@ module Google
|
|
|
997
868
|
# @return [Array<Google::Apis::ServiceconsumermanagementV1::Page>]
|
|
998
869
|
attr_accessor :pages
|
|
999
870
|
|
|
1000
|
-
# A list of documentation rules that apply to individual API elements.
|
|
1001
|
-
#
|
|
871
|
+
# A list of documentation rules that apply to individual API elements. **NOTE:**
|
|
872
|
+
# All service configuration rules follow "last one wins" order.
|
|
1002
873
|
# Corresponds to the JSON property `rules`
|
|
1003
874
|
# @return [Array<Google::Apis::ServiceconsumermanagementV1::DocumentationRule>]
|
|
1004
875
|
attr_accessor :rules
|
|
1005
876
|
|
|
1006
|
-
# Specifies the service root url if the default one (the service name
|
|
1007
|
-
#
|
|
1008
|
-
#
|
|
1009
|
-
# urls are relative to.
|
|
877
|
+
# Specifies the service root url if the default one (the service name from the
|
|
878
|
+
# yaml file) is not suitable. This can be seen in any fully specified service
|
|
879
|
+
# urls as well as sections that show a base that other urls are relative to.
|
|
1010
880
|
# Corresponds to the JSON property `serviceRootUrl`
|
|
1011
881
|
# @return [String]
|
|
1012
882
|
attr_accessor :service_root_url
|
|
1013
883
|
|
|
1014
|
-
# A short summary of what the service does. Can only be provided by
|
|
1015
|
-
# plain text.
|
|
884
|
+
# A short summary of what the service does. Can only be provided by plain text.
|
|
1016
885
|
# Corresponds to the JSON property `summary`
|
|
1017
886
|
# @return [String]
|
|
1018
887
|
attr_accessor :summary
|
|
@@ -1036,8 +905,8 @@ module Google
|
|
|
1036
905
|
class DocumentationRule
|
|
1037
906
|
include Google::Apis::Core::Hashable
|
|
1038
907
|
|
|
1039
|
-
# Deprecation description of the selected element(s). It can be provided if
|
|
1040
|
-
#
|
|
908
|
+
# Deprecation description of the selected element(s). It can be provided if an
|
|
909
|
+
# element is marked as `deprecated`.
|
|
1041
910
|
# Corresponds to the JSON property `deprecationDescription`
|
|
1042
911
|
# @return [String]
|
|
1043
912
|
attr_accessor :deprecation_description
|
|
@@ -1069,13 +938,11 @@ module Google
|
|
|
1069
938
|
end
|
|
1070
939
|
end
|
|
1071
940
|
|
|
1072
|
-
# A generic empty message that you can re-use to avoid defining duplicated
|
|
1073
|
-
#
|
|
1074
|
-
#
|
|
1075
|
-
#
|
|
1076
|
-
#
|
|
1077
|
-
# `
|
|
1078
|
-
# The JSON representation for `Empty` is empty JSON object ````.
|
|
941
|
+
# A generic empty message that you can re-use to avoid defining duplicated empty
|
|
942
|
+
# messages in your APIs. A typical example is to use it as the request or the
|
|
943
|
+
# response type of an API method. For instance: service Foo ` rpc Bar(google.
|
|
944
|
+
# protobuf.Empty) returns (google.protobuf.Empty); ` The JSON representation for
|
|
945
|
+
# `Empty` is empty JSON object ````.
|
|
1079
946
|
class Empty
|
|
1080
947
|
include Google::Apis::Core::Hashable
|
|
1081
948
|
|
|
@@ -1088,35 +955,28 @@ module Google
|
|
|
1088
955
|
end
|
|
1089
956
|
end
|
|
1090
957
|
|
|
1091
|
-
# `Endpoint` describes a network endpoint that serves a set of APIs.
|
|
1092
|
-
#
|
|
1093
|
-
#
|
|
1094
|
-
# configuration.
|
|
1095
|
-
#
|
|
1096
|
-
#
|
|
1097
|
-
#
|
|
1098
|
-
# #
|
|
1099
|
-
#
|
|
1100
|
-
# # It also allows HTTP OPTIONS calls to be passed to the backend, for
|
|
1101
|
-
# # it to decide whether the subsequent cross-origin request is
|
|
1102
|
-
# # allowed to proceed.
|
|
1103
|
-
# - name: library-example.googleapis.com
|
|
1104
|
-
# allow_cors: true
|
|
958
|
+
# `Endpoint` describes a network endpoint that serves a set of APIs. A service
|
|
959
|
+
# may expose any number of endpoints, and all endpoints share the same service
|
|
960
|
+
# configuration, such as quota configuration and monitoring configuration.
|
|
961
|
+
# Example service configuration: name: library-example.googleapis.com endpoints:
|
|
962
|
+
# # Below entry makes 'google.example.library.v1.Library' # API be served from
|
|
963
|
+
# endpoint address library-example.googleapis.com. # It also allows HTTP OPTIONS
|
|
964
|
+
# calls to be passed to the backend, for # it to decide whether the subsequent
|
|
965
|
+
# cross-origin request is # allowed to proceed. - name: library-example.
|
|
966
|
+
# googleapis.com allow_cors: true
|
|
1105
967
|
class Endpoint
|
|
1106
968
|
include Google::Apis::Core::Hashable
|
|
1107
969
|
|
|
1108
970
|
# DEPRECATED: This field is no longer supported. Instead of using aliases,
|
|
1109
|
-
# please specify multiple google.api.Endpoint for each of the intended
|
|
1110
|
-
# aliases.
|
|
971
|
+
# please specify multiple google.api.Endpoint for each of the intended aliases.
|
|
1111
972
|
# Additional names that this endpoint will be hosted on.
|
|
1112
973
|
# Corresponds to the JSON property `aliases`
|
|
1113
974
|
# @return [Array<String>]
|
|
1114
975
|
attr_accessor :aliases
|
|
1115
976
|
|
|
1116
|
-
# Allowing
|
|
1117
|
-
#
|
|
1118
|
-
#
|
|
1119
|
-
# receive and respond to HTTP OPTIONS requests. The response will be used by
|
|
977
|
+
# Allowing [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing),
|
|
978
|
+
# aka cross-domain traffic, would allow the backends served from this endpoint
|
|
979
|
+
# to receive and respond to HTTP OPTIONS requests. The response will be used by
|
|
1120
980
|
# the browser to determine whether the subsequent cross-origin request is
|
|
1121
981
|
# allowed to proceed.
|
|
1122
982
|
# Corresponds to the JSON property `allowCors`
|
|
@@ -1130,10 +990,9 @@ module Google
|
|
|
1130
990
|
attr_accessor :name
|
|
1131
991
|
|
|
1132
992
|
# The specification of an Internet routable address of API frontend that will
|
|
1133
|
-
# handle requests to this [API
|
|
1134
|
-
#
|
|
1135
|
-
#
|
|
1136
|
-
# "8.8.8.8" or "myservice.appspot.com".
|
|
993
|
+
# handle requests to this [API Endpoint](https://cloud.google.com/apis/design/
|
|
994
|
+
# glossary). It should be either a valid IPv4 address or a fully-qualified
|
|
995
|
+
# domain name. For example, "8.8.8.8" or "myservice.appspot.com".
|
|
1137
996
|
# Corresponds to the JSON property `target`
|
|
1138
997
|
# @return [String]
|
|
1139
998
|
attr_accessor :target
|
|
@@ -1170,8 +1029,8 @@ module Google
|
|
|
1170
1029
|
# @return [Array<Google::Apis::ServiceconsumermanagementV1::Option>]
|
|
1171
1030
|
attr_accessor :options
|
|
1172
1031
|
|
|
1173
|
-
# `SourceContext` represents information about the source of a
|
|
1174
|
-
#
|
|
1032
|
+
# `SourceContext` represents information about the source of a protobuf element,
|
|
1033
|
+
# like the file in which it is defined.
|
|
1175
1034
|
# Corresponds to the JSON property `sourceContext`
|
|
1176
1035
|
# @return [Google::Apis::ServiceconsumermanagementV1::SourceContext]
|
|
1177
1036
|
attr_accessor :source_context
|
|
@@ -1260,8 +1119,8 @@ module Google
|
|
|
1260
1119
|
# @return [Fixnum]
|
|
1261
1120
|
attr_accessor :number
|
|
1262
1121
|
|
|
1263
|
-
# The index of the field type in `Type.oneofs`, for message or enumeration
|
|
1264
|
-
#
|
|
1122
|
+
# The index of the field type in `Type.oneofs`, for message or enumeration types.
|
|
1123
|
+
# The first type has index 1; zero means the type is not in the list.
|
|
1265
1124
|
# Corresponds to the JSON property `oneofIndex`
|
|
1266
1125
|
# @return [Fixnum]
|
|
1267
1126
|
attr_accessor :oneof_index
|
|
@@ -1277,8 +1136,8 @@ module Google
|
|
|
1277
1136
|
attr_accessor :packed
|
|
1278
1137
|
alias_method :packed?, :packed
|
|
1279
1138
|
|
|
1280
|
-
# The field type URL, without the scheme, for message or enumeration
|
|
1281
|
-
#
|
|
1139
|
+
# The field type URL, without the scheme, for message or enumeration types.
|
|
1140
|
+
# Example: `"type.googleapis.com/google.protobuf.Timestamp"`.
|
|
1282
1141
|
# Corresponds to the JSON property `typeUrl`
|
|
1283
1142
|
# @return [String]
|
|
1284
1143
|
attr_accessor :type_url
|
|
@@ -1303,23 +1162,22 @@ module Google
|
|
|
1303
1162
|
end
|
|
1304
1163
|
|
|
1305
1164
|
# Defines the HTTP configuration for an API service. It contains a list of
|
|
1306
|
-
# HttpRule, each specifying the mapping of an RPC method
|
|
1307
|
-
#
|
|
1165
|
+
# HttpRule, each specifying the mapping of an RPC method to one or more HTTP
|
|
1166
|
+
# REST API methods.
|
|
1308
1167
|
class Http
|
|
1309
1168
|
include Google::Apis::Core::Hashable
|
|
1310
1169
|
|
|
1311
1170
|
# When set to true, URL path parameters will be fully URI-decoded except in
|
|
1312
1171
|
# cases of single segment matches in reserved expansion, where "%2F" will be
|
|
1313
|
-
# left encoded.
|
|
1314
|
-
#
|
|
1315
|
-
# segment matches.
|
|
1172
|
+
# left encoded. The default behavior is to not decode RFC 6570 reserved
|
|
1173
|
+
# characters in multi segment matches.
|
|
1316
1174
|
# Corresponds to the JSON property `fullyDecodeReservedExpansion`
|
|
1317
1175
|
# @return [Boolean]
|
|
1318
1176
|
attr_accessor :fully_decode_reserved_expansion
|
|
1319
1177
|
alias_method :fully_decode_reserved_expansion?, :fully_decode_reserved_expansion
|
|
1320
1178
|
|
|
1321
|
-
# A list of HTTP configuration rules that apply to individual API methods.
|
|
1322
|
-
#
|
|
1179
|
+
# A list of HTTP configuration rules that apply to individual API methods. **
|
|
1180
|
+
# NOTE:** All service configuration rules follow "last one wins" order.
|
|
1323
1181
|
# Corresponds to the JSON property `rules`
|
|
1324
1182
|
# @return [Array<Google::Apis::ServiceconsumermanagementV1::HttpRule>]
|
|
1325
1183
|
attr_accessor :rules
|
|
@@ -1335,251 +1193,156 @@ module Google
|
|
|
1335
1193
|
end
|
|
1336
1194
|
end
|
|
1337
1195
|
|
|
1338
|
-
# # gRPC Transcoding
|
|
1339
|
-
#
|
|
1340
|
-
#
|
|
1341
|
-
#
|
|
1342
|
-
#
|
|
1343
|
-
# [
|
|
1344
|
-
#
|
|
1345
|
-
#
|
|
1346
|
-
#
|
|
1347
|
-
#
|
|
1348
|
-
#
|
|
1349
|
-
# path, URL query parameters, and HTTP request body. It also controls how the
|
|
1350
|
-
# gRPC response message is mapped to the HTTP response body. `HttpRule` is
|
|
1196
|
+
# # gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC
|
|
1197
|
+
# method and one or more HTTP REST endpoints. It allows developers to build a
|
|
1198
|
+
# single API service that supports both gRPC APIs and REST APIs. Many systems,
|
|
1199
|
+
# including [Google APIs](https://github.com/googleapis/googleapis), [Cloud
|
|
1200
|
+
# Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.
|
|
1201
|
+
# com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/
|
|
1202
|
+
# envoy) proxy support this feature and use it for large scale production
|
|
1203
|
+
# services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping
|
|
1204
|
+
# specifies how different portions of the gRPC request message are mapped to the
|
|
1205
|
+
# URL path, URL query parameters, and HTTP request body. It also controls how
|
|
1206
|
+
# the gRPC response message is mapped to the HTTP response body. `HttpRule` is
|
|
1351
1207
|
# typically specified as an `google.api.http` annotation on the gRPC method.
|
|
1352
1208
|
# Each mapping specifies a URL path template and an HTTP method. The path
|
|
1353
1209
|
# template may refer to one or more fields in the gRPC request message, as long
|
|
1354
|
-
# as each field is a non-repeated field with a primitive (non-message) type.
|
|
1355
|
-
#
|
|
1356
|
-
#
|
|
1357
|
-
#
|
|
1358
|
-
#
|
|
1359
|
-
#
|
|
1360
|
-
#
|
|
1361
|
-
#
|
|
1362
|
-
#
|
|
1363
|
-
#
|
|
1364
|
-
# `
|
|
1365
|
-
#
|
|
1366
|
-
# string
|
|
1367
|
-
#
|
|
1368
|
-
#
|
|
1369
|
-
#
|
|
1370
|
-
# `
|
|
1371
|
-
#
|
|
1372
|
-
#
|
|
1373
|
-
#
|
|
1374
|
-
#
|
|
1375
|
-
#
|
|
1376
|
-
#
|
|
1377
|
-
#
|
|
1378
|
-
#
|
|
1379
|
-
# rpc
|
|
1380
|
-
#
|
|
1381
|
-
#
|
|
1382
|
-
#
|
|
1383
|
-
#
|
|
1384
|
-
# `
|
|
1385
|
-
#
|
|
1386
|
-
# message
|
|
1387
|
-
#
|
|
1388
|
-
#
|
|
1389
|
-
#
|
|
1390
|
-
#
|
|
1391
|
-
#
|
|
1392
|
-
# `
|
|
1393
|
-
#
|
|
1394
|
-
#
|
|
1395
|
-
#
|
|
1396
|
-
#
|
|
1397
|
-
#
|
|
1398
|
-
#
|
|
1399
|
-
#
|
|
1400
|
-
#
|
|
1401
|
-
#
|
|
1402
|
-
#
|
|
1403
|
-
#
|
|
1404
|
-
#
|
|
1405
|
-
#
|
|
1406
|
-
#
|
|
1407
|
-
#
|
|
1408
|
-
#
|
|
1409
|
-
#
|
|
1410
|
-
#
|
|
1411
|
-
#
|
|
1412
|
-
#
|
|
1413
|
-
#
|
|
1414
|
-
#
|
|
1415
|
-
#
|
|
1416
|
-
#
|
|
1417
|
-
#
|
|
1418
|
-
#
|
|
1419
|
-
# `
|
|
1420
|
-
# The
|
|
1421
|
-
#
|
|
1422
|
-
#
|
|
1423
|
-
#
|
|
1424
|
-
#
|
|
1425
|
-
#
|
|
1426
|
-
#
|
|
1427
|
-
#
|
|
1428
|
-
#
|
|
1429
|
-
#
|
|
1430
|
-
# the
|
|
1431
|
-
#
|
|
1432
|
-
#
|
|
1433
|
-
#
|
|
1434
|
-
#
|
|
1435
|
-
#
|
|
1436
|
-
#
|
|
1437
|
-
#
|
|
1438
|
-
#
|
|
1439
|
-
#
|
|
1440
|
-
#
|
|
1441
|
-
#
|
|
1442
|
-
# `
|
|
1443
|
-
# The following HTTP JSON to RPC mapping is enabled:
|
|
1444
|
-
# HTTP | gRPC
|
|
1445
|
-
# -----|-----
|
|
1446
|
-
# `PATCH /v1/messages/123456 ` "text": "Hi!" `` | `UpdateMessage(message_id:
|
|
1447
|
-
# "123456" text: "Hi!")`
|
|
1448
|
-
# Note that when using `*` in the body mapping, it is not possible to
|
|
1449
|
-
# have HTTP parameters, as all fields not bound by the path end in
|
|
1450
|
-
# the body. This makes this option more rarely used in practice when
|
|
1451
|
-
# defining REST APIs. The common usage of `*` is in custom methods
|
|
1452
|
-
# which don't use the URL at all for transferring data.
|
|
1453
|
-
# It is possible to define multiple HTTP methods for one RPC by using
|
|
1454
|
-
# the `additional_bindings` option. Example:
|
|
1455
|
-
# service Messaging `
|
|
1456
|
-
# rpc GetMessage(GetMessageRequest) returns (Message) `
|
|
1457
|
-
# option (google.api.http) = `
|
|
1458
|
-
# get: "/v1/messages/`message_id`"
|
|
1459
|
-
# additional_bindings `
|
|
1460
|
-
# get: "/v1/users/`user_id`/messages/`message_id`"
|
|
1461
|
-
# `
|
|
1462
|
-
# `;
|
|
1463
|
-
# `
|
|
1464
|
-
# `
|
|
1465
|
-
# message GetMessageRequest `
|
|
1466
|
-
# string message_id = 1;
|
|
1467
|
-
# string user_id = 2;
|
|
1468
|
-
# `
|
|
1469
|
-
# This enables the following two alternative HTTP JSON to RPC mappings:
|
|
1470
|
-
# HTTP | gRPC
|
|
1471
|
-
# -----|-----
|
|
1472
|
-
# `GET /v1/messages/123456` | `GetMessage(message_id: "123456")`
|
|
1473
|
-
# `GET /v1/users/me/messages/123456` | `GetMessage(user_id: "me" message_id:
|
|
1474
|
-
# "123456")`
|
|
1475
|
-
# ## Rules for HTTP mapping
|
|
1476
|
-
# 1. Leaf request fields (recursive expansion nested messages in the request
|
|
1477
|
-
# message) are classified into three categories:
|
|
1478
|
-
# - Fields referred by the path template. They are passed via the URL path.
|
|
1479
|
-
# - Fields referred by the HttpRule.body. They are passed via the HTTP
|
|
1480
|
-
# request body.
|
|
1481
|
-
# - All other fields are passed via the URL query parameters, and the
|
|
1482
|
-
# parameter name is the field path in the request message. A repeated
|
|
1483
|
-
# field can be represented as multiple query parameters under the same
|
|
1484
|
-
# name.
|
|
1485
|
-
# 2. If HttpRule.body is "*", there is no URL query parameter, all fields
|
|
1486
|
-
# are passed via URL path and HTTP request body.
|
|
1487
|
-
# 3. If HttpRule.body is omitted, there is no HTTP request body, all
|
|
1488
|
-
# fields are passed via URL path and URL query parameters.
|
|
1489
|
-
# ### Path template syntax
|
|
1490
|
-
# Template = "/" Segments [ Verb ] ;
|
|
1491
|
-
# Segments = Segment ` "/" Segment ` ;
|
|
1492
|
-
# Segment = "*" | "**" | LITERAL | Variable ;
|
|
1493
|
-
# Variable = "`" FieldPath [ "=" Segments ] "`" ;
|
|
1494
|
-
# FieldPath = IDENT ` "." IDENT ` ;
|
|
1495
|
-
# Verb = ":" LITERAL ;
|
|
1496
|
-
# The syntax `*` matches a single URL path segment. The syntax `**` matches
|
|
1497
|
-
# zero or more URL path segments, which must be the last part of the URL path
|
|
1498
|
-
# except the `Verb`.
|
|
1499
|
-
# The syntax `Variable` matches part of the URL path as specified by its
|
|
1500
|
-
# template. A variable template must not contain other variables. If a variable
|
|
1501
|
-
# matches a single path segment, its template may be omitted, e.g. ``var``
|
|
1502
|
-
# is equivalent to ``var=*``.
|
|
1503
|
-
# The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL`
|
|
1504
|
-
# contains any reserved character, such characters should be percent-encoded
|
|
1505
|
-
# before the matching.
|
|
1506
|
-
# If a variable contains exactly one path segment, such as `"`var`"` or
|
|
1507
|
-
# `"`var=*`"`, when such a variable is expanded into a URL path on the client
|
|
1508
|
-
# side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The
|
|
1509
|
-
# server side does the reverse decoding. Such variables show up in the
|
|
1510
|
-
# [Discovery
|
|
1511
|
-
# Document](https://developers.google.com/discovery/v1/reference/apis) as
|
|
1512
|
-
# ``var``.
|
|
1513
|
-
# If a variable contains multiple path segments, such as `"`var=foo/*`"`
|
|
1514
|
-
# or `"`var=**`"`, when such a variable is expanded into a URL path on the
|
|
1515
|
-
# client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded.
|
|
1516
|
-
# The server side does the reverse decoding, except "%2F" and "%2f" are left
|
|
1517
|
-
# unchanged. Such variables show up in the
|
|
1518
|
-
# [Discovery
|
|
1519
|
-
# Document](https://developers.google.com/discovery/v1/reference/apis) as
|
|
1520
|
-
# ``+var``.
|
|
1521
|
-
# ## Using gRPC API Service Configuration
|
|
1522
|
-
# gRPC API Service Configuration (service config) is a configuration language
|
|
1523
|
-
# for configuring a gRPC service to become a user-facing product. The
|
|
1524
|
-
# service config is simply the YAML representation of the `google.api.Service`
|
|
1525
|
-
# proto message.
|
|
1210
|
+
# as each field is a non-repeated field with a primitive (non-message) type. The
|
|
1211
|
+
# path template controls how fields of the request message are mapped to the URL
|
|
1212
|
+
# path. Example: service Messaging ` rpc GetMessage(GetMessageRequest) returns (
|
|
1213
|
+
# Message) ` option (google.api.http) = ` get: "/v1/`name=messages/*`" `; ` `
|
|
1214
|
+
# message GetMessageRequest ` string name = 1; // Mapped to URL path. ` message
|
|
1215
|
+
# Message ` string text = 1; // The resource content. ` This enables an HTTP
|
|
1216
|
+
# REST to gRPC mapping as below: HTTP | gRPC -----|----- `GET /v1/messages/
|
|
1217
|
+
# 123456` | `GetMessage(name: "messages/123456")` Any fields in the request
|
|
1218
|
+
# message which are not bound by the path template automatically become HTTP
|
|
1219
|
+
# query parameters if there is no HTTP request body. For example: service
|
|
1220
|
+
# Messaging ` rpc GetMessage(GetMessageRequest) returns (Message) ` option (
|
|
1221
|
+
# google.api.http) = ` get:"/v1/messages/`message_id`" `; ` ` message
|
|
1222
|
+
# GetMessageRequest ` message SubMessage ` string subfield = 1; ` string
|
|
1223
|
+
# message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL
|
|
1224
|
+
# query parameter `revision`. SubMessage sub = 3; // Mapped to URL query
|
|
1225
|
+
# parameter `sub.subfield`. ` This enables a HTTP JSON to RPC mapping as below:
|
|
1226
|
+
# HTTP | gRPC -----|----- `GET /v1/messages/123456?revision=2&sub.subfield=foo` |
|
|
1227
|
+
# `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: "foo"))
|
|
1228
|
+
# ` Note that fields which are mapped to URL query parameters must have a
|
|
1229
|
+
# primitive type or a repeated primitive type or a non-repeated message type. In
|
|
1230
|
+
# the case of a repeated type, the parameter can be repeated in the URL as `...?
|
|
1231
|
+
# param=A¶m=B`. In the case of a message type, each field of the message is
|
|
1232
|
+
# mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For
|
|
1233
|
+
# HTTP methods that allow a request body, the `body` field specifies the mapping.
|
|
1234
|
+
# Consider a REST update method on the message resource collection: service
|
|
1235
|
+
# Messaging ` rpc UpdateMessage(UpdateMessageRequest) returns (Message) ` option
|
|
1236
|
+
# (google.api.http) = ` patch: "/v1/messages/`message_id`" body: "message" `; ` `
|
|
1237
|
+
# message UpdateMessageRequest ` string message_id = 1; // mapped to the URL
|
|
1238
|
+
# Message message = 2; // mapped to the body ` The following HTTP JSON to RPC
|
|
1239
|
+
# mapping is enabled, where the representation of the JSON in the request body
|
|
1240
|
+
# is determined by protos JSON encoding: HTTP | gRPC -----|----- `PATCH /v1/
|
|
1241
|
+
# messages/123456 ` "text": "Hi!" `` | `UpdateMessage(message_id: "123456"
|
|
1242
|
+
# message ` text: "Hi!" `)` The special name `*` can be used in the body mapping
|
|
1243
|
+
# to define that every field not bound by the path template should be mapped to
|
|
1244
|
+
# the request body. This enables the following alternative definition of the
|
|
1245
|
+
# update method: service Messaging ` rpc UpdateMessage(Message) returns (Message)
|
|
1246
|
+
# ` option (google.api.http) = ` patch: "/v1/messages/`message_id`" body: "*" `;
|
|
1247
|
+
# ` ` message Message ` string message_id = 1; string text = 2; ` The following
|
|
1248
|
+
# HTTP JSON to RPC mapping is enabled: HTTP | gRPC -----|----- `PATCH /v1/
|
|
1249
|
+
# messages/123456 ` "text": "Hi!" `` | `UpdateMessage(message_id: "123456" text:
|
|
1250
|
+
# "Hi!")` Note that when using `*` in the body mapping, it is not possible to
|
|
1251
|
+
# have HTTP parameters, as all fields not bound by the path end in the body.
|
|
1252
|
+
# This makes this option more rarely used in practice when defining REST APIs.
|
|
1253
|
+
# The common usage of `*` is in custom methods which don't use the URL at all
|
|
1254
|
+
# for transferring data. It is possible to define multiple HTTP methods for one
|
|
1255
|
+
# RPC by using the `additional_bindings` option. Example: service Messaging `
|
|
1256
|
+
# rpc GetMessage(GetMessageRequest) returns (Message) ` option (google.api.http)
|
|
1257
|
+
# = ` get: "/v1/messages/`message_id`" additional_bindings ` get: "/v1/users/`
|
|
1258
|
+
# user_id`/messages/`message_id`" ` `; ` ` message GetMessageRequest ` string
|
|
1259
|
+
# message_id = 1; string user_id = 2; ` This enables the following two
|
|
1260
|
+
# alternative HTTP JSON to RPC mappings: HTTP | gRPC -----|----- `GET /v1/
|
|
1261
|
+
# messages/123456` | `GetMessage(message_id: "123456")` `GET /v1/users/me/
|
|
1262
|
+
# messages/123456` | `GetMessage(user_id: "me" message_id: "123456")` ## Rules
|
|
1263
|
+
# for HTTP mapping 1. Leaf request fields (recursive expansion nested messages
|
|
1264
|
+
# in the request message) are classified into three categories: - Fields
|
|
1265
|
+
# referred by the path template. They are passed via the URL path. - Fields
|
|
1266
|
+
# referred by the HttpRule.body. They are passed via the HTTP request body. -
|
|
1267
|
+
# All other fields are passed via the URL query parameters, and the parameter
|
|
1268
|
+
# name is the field path in the request message. A repeated field can be
|
|
1269
|
+
# represented as multiple query parameters under the same name. 2. If HttpRule.
|
|
1270
|
+
# body is "*", there is no URL query parameter, all fields are passed via URL
|
|
1271
|
+
# path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP
|
|
1272
|
+
# request body, all fields are passed via URL path and URL query parameters. ###
|
|
1273
|
+
# Path template syntax Template = "/" Segments [ Verb ] ; Segments = Segment ` "/
|
|
1274
|
+
# " Segment ` ; Segment = "*" | "**" | LITERAL | Variable ; Variable = "`"
|
|
1275
|
+
# FieldPath [ "=" Segments ] "`" ; FieldPath = IDENT ` "." IDENT ` ; Verb = ":"
|
|
1276
|
+
# LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**`
|
|
1277
|
+
# matches zero or more URL path segments, which must be the last part of the URL
|
|
1278
|
+
# path except the `Verb`. The syntax `Variable` matches part of the URL path as
|
|
1279
|
+
# specified by its template. A variable template must not contain other
|
|
1280
|
+
# variables. If a variable matches a single path segment, its template may be
|
|
1281
|
+
# omitted, e.g. ``var`` is equivalent to ``var=*``. The syntax `LITERAL` matches
|
|
1282
|
+
# literal text in the URL path. If the `LITERAL` contains any reserved character,
|
|
1283
|
+
# such characters should be percent-encoded before the matching. If a variable
|
|
1284
|
+
# contains exactly one path segment, such as `"`var`"` or `"`var=*`"`, when such
|
|
1285
|
+
# a variable is expanded into a URL path on the client side, all characters
|
|
1286
|
+
# except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse
|
|
1287
|
+
# decoding. Such variables show up in the [Discovery Document](https://
|
|
1288
|
+
# developers.google.com/discovery/v1/reference/apis) as ``var``. If a variable
|
|
1289
|
+
# contains multiple path segments, such as `"`var=foo/*`"` or `"`var=**`"`, when
|
|
1290
|
+
# such a variable is expanded into a URL path on the client side, all characters
|
|
1291
|
+
# except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the
|
|
1292
|
+
# reverse decoding, except "%2F" and "%2f" are left unchanged. Such variables
|
|
1293
|
+
# show up in the [Discovery Document](https://developers.google.com/discovery/v1/
|
|
1294
|
+
# reference/apis) as ``+var``. ## Using gRPC API Service Configuration gRPC API
|
|
1295
|
+
# Service Configuration (service config) is a configuration language for
|
|
1296
|
+
# configuring a gRPC service to become a user-facing product. The service config
|
|
1297
|
+
# is simply the YAML representation of the `google.api.Service` proto message.
|
|
1526
1298
|
# As an alternative to annotating your proto file, you can configure gRPC
|
|
1527
|
-
# transcoding in your service config YAML files. You do this by specifying a
|
|
1528
|
-
#
|
|
1529
|
-
# effect as the proto annotation. This can be particularly useful if you
|
|
1530
|
-
#
|
|
1531
|
-
#
|
|
1532
|
-
#
|
|
1533
|
-
#
|
|
1534
|
-
#
|
|
1535
|
-
#
|
|
1536
|
-
#
|
|
1537
|
-
#
|
|
1538
|
-
#
|
|
1539
|
-
#
|
|
1540
|
-
#
|
|
1541
|
-
#
|
|
1542
|
-
#
|
|
1543
|
-
# .
|
|
1544
|
-
#
|
|
1545
|
-
#
|
|
1546
|
-
#
|
|
1547
|
-
#
|
|
1548
|
-
#
|
|
1549
|
-
#
|
|
1550
|
-
# for
|
|
1551
|
-
#
|
|
1552
|
-
#
|
|
1553
|
-
# The path variables **must not** capture the leading "/" character. The reason
|
|
1554
|
-
# is that the most common use case "`var`" does not capture the leading "/"
|
|
1555
|
-
# character. For consistency, all path variables must share the same behavior.
|
|
1556
|
-
# Repeated message fields must not be mapped to URL query parameters, because
|
|
1557
|
-
# no client library can support such complicated mapping.
|
|
1558
|
-
# If an API needs to use a JSON array for request or response body, it can map
|
|
1559
|
-
# the request or response body to a repeated field. However, some gRPC
|
|
1560
|
-
# Transcoding implementations may not support this feature.
|
|
1299
|
+
# transcoding in your service config YAML files. You do this by specifying a `
|
|
1300
|
+
# HttpRule` that maps the gRPC method to a REST endpoint, achieving the same
|
|
1301
|
+
# effect as the proto annotation. This can be particularly useful if you have a
|
|
1302
|
+
# proto that is reused in multiple services. Note that any transcoding specified
|
|
1303
|
+
# in the service config will override any matching transcoding configuration in
|
|
1304
|
+
# the proto. Example: http: rules: # Selects a gRPC method and applies HttpRule
|
|
1305
|
+
# to it. - selector: example.v1.Messaging.GetMessage get: /v1/messages/`
|
|
1306
|
+
# message_id`/`sub.subfield` ## Special notes When gRPC Transcoding is used to
|
|
1307
|
+
# map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow
|
|
1308
|
+
# the [proto3 specification](https://developers.google.com/protocol-buffers/docs/
|
|
1309
|
+
# proto3#json). While the single segment variable follows the semantics of [RFC
|
|
1310
|
+
# 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String
|
|
1311
|
+
# Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.
|
|
1312
|
+
# 3 Reserved Expansion. The reason is that the Reserved Expansion does not
|
|
1313
|
+
# expand special characters like `?` and `#`, which would lead to invalid URLs.
|
|
1314
|
+
# As the result, gRPC Transcoding uses a custom encoding for multi segment
|
|
1315
|
+
# variables. The path variables **must not** refer to any repeated or mapped
|
|
1316
|
+
# field, because client libraries are not capable of handling such variable
|
|
1317
|
+
# expansion. The path variables **must not** capture the leading "/" character.
|
|
1318
|
+
# The reason is that the most common use case "`var`" does not capture the
|
|
1319
|
+
# leading "/" character. For consistency, all path variables must share the same
|
|
1320
|
+
# behavior. Repeated message fields must not be mapped to URL query parameters,
|
|
1321
|
+
# because no client library can support such complicated mapping. If an API
|
|
1322
|
+
# needs to use a JSON array for request or response body, it can map the request
|
|
1323
|
+
# or response body to a repeated field. However, some gRPC Transcoding
|
|
1324
|
+
# implementations may not support this feature.
|
|
1561
1325
|
class HttpRule
|
|
1562
1326
|
include Google::Apis::Core::Hashable
|
|
1563
1327
|
|
|
1564
|
-
# Additional HTTP bindings for the selector. Nested bindings must
|
|
1565
|
-
#
|
|
1566
|
-
#
|
|
1328
|
+
# Additional HTTP bindings for the selector. Nested bindings must not contain an
|
|
1329
|
+
# `additional_bindings` field themselves (that is, the nesting may only be one
|
|
1330
|
+
# level deep).
|
|
1567
1331
|
# Corresponds to the JSON property `additionalBindings`
|
|
1568
1332
|
# @return [Array<Google::Apis::ServiceconsumermanagementV1::HttpRule>]
|
|
1569
1333
|
attr_accessor :additional_bindings
|
|
1570
1334
|
|
|
1571
|
-
# When this flag is set to true, HTTP requests will be allowed to invoke a
|
|
1572
|
-
#
|
|
1335
|
+
# When this flag is set to true, HTTP requests will be allowed to invoke a half-
|
|
1336
|
+
# duplex streaming method.
|
|
1573
1337
|
# Corresponds to the JSON property `allowHalfDuplex`
|
|
1574
1338
|
# @return [Boolean]
|
|
1575
1339
|
attr_accessor :allow_half_duplex
|
|
1576
1340
|
alias_method :allow_half_duplex?, :allow_half_duplex
|
|
1577
1341
|
|
|
1578
|
-
# The name of the request field whose value is mapped to the HTTP request
|
|
1579
|
-
#
|
|
1580
|
-
#
|
|
1581
|
-
#
|
|
1582
|
-
# message type.
|
|
1342
|
+
# The name of the request field whose value is mapped to the HTTP request body,
|
|
1343
|
+
# or `*` for mapping all request fields not captured by the path pattern to the
|
|
1344
|
+
# HTTP body, or omitted for not having any HTTP request body. NOTE: the referred
|
|
1345
|
+
# field must be present at the top-level of the request message type.
|
|
1583
1346
|
# Corresponds to the JSON property `body`
|
|
1584
1347
|
# @return [String]
|
|
1585
1348
|
attr_accessor :body
|
|
@@ -1594,8 +1357,7 @@ module Google
|
|
|
1594
1357
|
# @return [String]
|
|
1595
1358
|
attr_accessor :delete
|
|
1596
1359
|
|
|
1597
|
-
# Maps to HTTP GET. Used for listing and getting information about
|
|
1598
|
-
# resources.
|
|
1360
|
+
# Maps to HTTP GET. Used for listing and getting information about resources.
|
|
1599
1361
|
# Corresponds to the JSON property `get`
|
|
1600
1362
|
# @return [String]
|
|
1601
1363
|
attr_accessor :get
|
|
@@ -1616,16 +1378,15 @@ module Google
|
|
|
1616
1378
|
attr_accessor :put
|
|
1617
1379
|
|
|
1618
1380
|
# Optional. The name of the response field whose value is mapped to the HTTP
|
|
1619
|
-
# response body. When omitted, the entire response message will be used
|
|
1620
|
-
#
|
|
1621
|
-
#
|
|
1622
|
-
# message type.
|
|
1381
|
+
# response body. When omitted, the entire response message will be used as the
|
|
1382
|
+
# HTTP response body. NOTE: The referred field must be present at the top-level
|
|
1383
|
+
# of the response message type.
|
|
1623
1384
|
# Corresponds to the JSON property `responseBody`
|
|
1624
1385
|
# @return [String]
|
|
1625
1386
|
attr_accessor :response_body
|
|
1626
1387
|
|
|
1627
|
-
# Selects a method to which this rule applies.
|
|
1628
|
-
#
|
|
1388
|
+
# Selects a method to which this rule applies. Refer to selector for syntax
|
|
1389
|
+
# details.
|
|
1629
1390
|
# Corresponds to the JSON property `selector`
|
|
1630
1391
|
# @return [String]
|
|
1631
1392
|
attr_accessor :selector
|
|
@@ -1664,13 +1425,12 @@ module Google
|
|
|
1664
1425
|
# @return [String]
|
|
1665
1426
|
attr_accessor :query
|
|
1666
1427
|
|
|
1667
|
-
# The value prefix. The value format is "value_prefix`token`"
|
|
1668
|
-
#
|
|
1669
|
-
#
|
|
1670
|
-
# If
|
|
1671
|
-
#
|
|
1672
|
-
#
|
|
1673
|
-
# value_prefix="Bearer " with a space at the end.
|
|
1428
|
+
# The value prefix. The value format is "value_prefix`token`" Only applies to "
|
|
1429
|
+
# in" header type. Must be empty for "in" query type. If not empty, the header
|
|
1430
|
+
# value has to match (case sensitive) this prefix. If not matched, JWT will not
|
|
1431
|
+
# be extracted. If matched, JWT will be extracted after the prefix is removed.
|
|
1432
|
+
# For example, for "Authorization: Bearer `JWT`", value_prefix="Bearer " with a
|
|
1433
|
+
# space at the end.
|
|
1674
1434
|
# Corresponds to the JSON property `valuePrefix`
|
|
1675
1435
|
# @return [String]
|
|
1676
1436
|
attr_accessor :value_prefix
|
|
@@ -1768,39 +1528,35 @@ module Google
|
|
|
1768
1528
|
end
|
|
1769
1529
|
end
|
|
1770
1530
|
|
|
1771
|
-
# A description of a log type. Example in YAML format:
|
|
1772
|
-
#
|
|
1773
|
-
#
|
|
1774
|
-
# display_name: Activity
|
|
1775
|
-
# labels:
|
|
1776
|
-
# - key: /customer_id
|
|
1531
|
+
# A description of a log type. Example in YAML format: - name: library.
|
|
1532
|
+
# googleapis.com/activity_history description: The history of borrowing and
|
|
1533
|
+
# returning library items. display_name: Activity labels: - key: /customer_id
|
|
1777
1534
|
# description: Identifier of a library customer
|
|
1778
1535
|
class LogDescriptor
|
|
1779
1536
|
include Google::Apis::Core::Hashable
|
|
1780
1537
|
|
|
1781
|
-
# A human-readable description of this log. This information appears in
|
|
1782
|
-
#
|
|
1538
|
+
# A human-readable description of this log. This information appears in the
|
|
1539
|
+
# documentation and can contain details.
|
|
1783
1540
|
# Corresponds to the JSON property `description`
|
|
1784
1541
|
# @return [String]
|
|
1785
1542
|
attr_accessor :description
|
|
1786
1543
|
|
|
1787
|
-
# The human-readable name for this log. This information appears on
|
|
1788
|
-
#
|
|
1544
|
+
# The human-readable name for this log. This information appears on the user
|
|
1545
|
+
# interface and should be concise.
|
|
1789
1546
|
# Corresponds to the JSON property `displayName`
|
|
1790
1547
|
# @return [String]
|
|
1791
1548
|
attr_accessor :display_name
|
|
1792
1549
|
|
|
1793
|
-
# The set of labels that are available to describe a specific log entry.
|
|
1794
|
-
#
|
|
1795
|
-
# considered invalid.
|
|
1550
|
+
# The set of labels that are available to describe a specific log entry. Runtime
|
|
1551
|
+
# requests that contain labels not specified here are considered invalid.
|
|
1796
1552
|
# Corresponds to the JSON property `labels`
|
|
1797
1553
|
# @return [Array<Google::Apis::ServiceconsumermanagementV1::LabelDescriptor>]
|
|
1798
1554
|
attr_accessor :labels
|
|
1799
1555
|
|
|
1800
|
-
# The name of the log. It must be less than 512 characters long and can
|
|
1801
|
-
#
|
|
1802
|
-
#
|
|
1803
|
-
#
|
|
1556
|
+
# The name of the log. It must be less than 512 characters long and can include
|
|
1557
|
+
# the following characters: upper- and lower-case alphanumeric characters [A-Za-
|
|
1558
|
+
# z0-9], and punctuation characters including slash, underscore, hyphen, period [
|
|
1559
|
+
# /_-.].
|
|
1804
1560
|
# Corresponds to the JSON property `name`
|
|
1805
1561
|
# @return [String]
|
|
1806
1562
|
attr_accessor :name
|
|
@@ -1818,48 +1574,30 @@ module Google
|
|
|
1818
1574
|
end
|
|
1819
1575
|
end
|
|
1820
1576
|
|
|
1821
|
-
# Logging configuration of the service.
|
|
1822
|
-
#
|
|
1823
|
-
#
|
|
1824
|
-
# log is sent to
|
|
1825
|
-
#
|
|
1826
|
-
#
|
|
1827
|
-
# -
|
|
1828
|
-
# labels:
|
|
1829
|
-
# -
|
|
1830
|
-
#
|
|
1831
|
-
#
|
|
1832
|
-
# description: The name of the branch.
|
|
1833
|
-
# logs:
|
|
1834
|
-
# - name: activity_history
|
|
1835
|
-
# labels:
|
|
1836
|
-
# - key: /customer_id
|
|
1837
|
-
# - name: purchase_history
|
|
1838
|
-
# logging:
|
|
1839
|
-
# producer_destinations:
|
|
1840
|
-
# - monitored_resource: library.googleapis.com/branch
|
|
1841
|
-
# logs:
|
|
1842
|
-
# - activity_history
|
|
1843
|
-
# - purchase_history
|
|
1844
|
-
# consumer_destinations:
|
|
1845
|
-
# - monitored_resource: library.googleapis.com/branch
|
|
1846
|
-
# logs:
|
|
1847
|
-
# - activity_history
|
|
1577
|
+
# Logging configuration of the service. The following example shows how to
|
|
1578
|
+
# configure logs to be sent to the producer and consumer projects. In the
|
|
1579
|
+
# example, the `activity_history` log is sent to both the producer and consumer
|
|
1580
|
+
# projects, whereas the `purchase_history` log is only sent to the producer
|
|
1581
|
+
# project. monitored_resources: - type: library.googleapis.com/branch labels: -
|
|
1582
|
+
# key: /city description: The city where the library branch is located in. - key:
|
|
1583
|
+
# /name description: The name of the branch. logs: - name: activity_history
|
|
1584
|
+
# labels: - key: /customer_id - name: purchase_history logging:
|
|
1585
|
+
# producer_destinations: - monitored_resource: library.googleapis.com/branch
|
|
1586
|
+
# logs: - activity_history - purchase_history consumer_destinations: -
|
|
1587
|
+
# monitored_resource: library.googleapis.com/branch logs: - activity_history
|
|
1848
1588
|
class Logging
|
|
1849
1589
|
include Google::Apis::Core::Hashable
|
|
1850
1590
|
|
|
1851
|
-
# Logging configurations for sending logs to the consumer project.
|
|
1852
|
-
#
|
|
1853
|
-
#
|
|
1854
|
-
# one consumer destination.
|
|
1591
|
+
# Logging configurations for sending logs to the consumer project. There can be
|
|
1592
|
+
# multiple consumer destinations, each one must have a different monitored
|
|
1593
|
+
# resource type. A log can be used in at most one consumer destination.
|
|
1855
1594
|
# Corresponds to the JSON property `consumerDestinations`
|
|
1856
1595
|
# @return [Array<Google::Apis::ServiceconsumermanagementV1::LoggingDestination>]
|
|
1857
1596
|
attr_accessor :consumer_destinations
|
|
1858
1597
|
|
|
1859
|
-
# Logging configurations for sending logs to the producer project.
|
|
1860
|
-
#
|
|
1861
|
-
#
|
|
1862
|
-
# one producer destination.
|
|
1598
|
+
# Logging configurations for sending logs to the producer project. There can be
|
|
1599
|
+
# multiple producer destinations, each one must have a different monitored
|
|
1600
|
+
# resource type. A log can be used in at most one producer destination.
|
|
1863
1601
|
# Corresponds to the JSON property `producerDestinations`
|
|
1864
1602
|
# @return [Array<Google::Apis::ServiceconsumermanagementV1::LoggingDestination>]
|
|
1865
1603
|
attr_accessor :producer_destinations
|
|
@@ -1875,21 +1613,20 @@ module Google
|
|
|
1875
1613
|
end
|
|
1876
1614
|
end
|
|
1877
1615
|
|
|
1878
|
-
# Configuration of a specific logging destination (the producer project
|
|
1879
|
-
#
|
|
1616
|
+
# Configuration of a specific logging destination (the producer project or the
|
|
1617
|
+
# consumer project).
|
|
1880
1618
|
class LoggingDestination
|
|
1881
1619
|
include Google::Apis::Core::Hashable
|
|
1882
1620
|
|
|
1883
|
-
# Names of the logs to be sent to this destination. Each name must
|
|
1884
|
-
#
|
|
1885
|
-
#
|
|
1886
|
-
# the service name followed by "/".
|
|
1621
|
+
# Names of the logs to be sent to this destination. Each name must be defined in
|
|
1622
|
+
# the Service.logs section. If the log name is not a domain scoped name, it will
|
|
1623
|
+
# be automatically prefixed with the service name followed by "/".
|
|
1887
1624
|
# Corresponds to the JSON property `logs`
|
|
1888
1625
|
# @return [Array<String>]
|
|
1889
1626
|
attr_accessor :logs
|
|
1890
1627
|
|
|
1891
|
-
# The monitored resource type. The type must be defined in the
|
|
1892
|
-
#
|
|
1628
|
+
# The monitored resource type. The type must be defined in the Service.
|
|
1629
|
+
# monitored_resources section.
|
|
1893
1630
|
# Corresponds to the JSON property `monitoredResource`
|
|
1894
1631
|
# @return [String]
|
|
1895
1632
|
attr_accessor :monitored_resource
|
|
@@ -1964,16 +1701,13 @@ module Google
|
|
|
1964
1701
|
|
|
1965
1702
|
# Defines a metric type and its schema. Once a metric descriptor is created,
|
|
1966
1703
|
# deleting or altering it stops data collection and makes the metric type's
|
|
1967
|
-
# existing data unusable.
|
|
1968
|
-
#
|
|
1969
|
-
#
|
|
1970
|
-
#
|
|
1971
|
-
#
|
|
1972
|
-
#
|
|
1973
|
-
#
|
|
1974
|
-
# * Maximum of default 10 labels per metric descriptor is allowed.
|
|
1975
|
-
# The default maximum limit can be overridden. Please follow
|
|
1976
|
-
# https://cloud.google.com/monitoring/quotas
|
|
1704
|
+
# existing data unusable. The following are specific rules for service defined
|
|
1705
|
+
# Monitoring metric descriptors: * `type`, `metric_kind`, `value_type` and `
|
|
1706
|
+
# description` fields are all required. The `unit` field must be specified if
|
|
1707
|
+
# the `value_type` is any of DOUBLE, INT64, DISTRIBUTION. * Maximum of default
|
|
1708
|
+
# 500 metric descriptors per service is allowed. * Maximum of default 10 labels
|
|
1709
|
+
# per metric descriptor is allowed. The default maximum limit can be overridden.
|
|
1710
|
+
# Please follow https://cloud.google.com/monitoring/quotas
|
|
1977
1711
|
class MetricDescriptor
|
|
1978
1712
|
include Google::Apis::Core::Hashable
|
|
1979
1713
|
|
|
@@ -1982,26 +1716,21 @@ module Google
|
|
|
1982
1716
|
# @return [String]
|
|
1983
1717
|
attr_accessor :description
|
|
1984
1718
|
|
|
1985
|
-
# A concise name for the metric, which can be displayed in user interfaces.
|
|
1986
|
-
#
|
|
1987
|
-
#
|
|
1988
|
-
#
|
|
1719
|
+
# A concise name for the metric, which can be displayed in user interfaces. Use
|
|
1720
|
+
# sentence case without an ending period, for example "Request count". This
|
|
1721
|
+
# field is optional but it is recommended to be set for any metrics associated
|
|
1722
|
+
# with user-visible concepts, such as Quota.
|
|
1989
1723
|
# Corresponds to the JSON property `displayName`
|
|
1990
1724
|
# @return [String]
|
|
1991
1725
|
attr_accessor :display_name
|
|
1992
1726
|
|
|
1993
|
-
# The set of labels that can be used to describe a specific
|
|
1994
|
-
#
|
|
1995
|
-
#
|
|
1996
|
-
# *
|
|
1997
|
-
#
|
|
1998
|
-
#
|
|
1999
|
-
#
|
|
2000
|
-
# For example, the
|
|
2001
|
-
# `appengine.googleapis.com/http/server/response_latencies` metric
|
|
2002
|
-
# type has a label for the HTTP response code, `response_code`, so
|
|
2003
|
-
# you can look at latencies for successful responses or just
|
|
2004
|
-
# for responses that failed.
|
|
1727
|
+
# The set of labels that can be used to describe a specific instance of this
|
|
1728
|
+
# metric type. The label key name must follow: * Only upper and lower-case
|
|
1729
|
+
# letters, digits and underscores (_) are allowed. * Label name must start with
|
|
1730
|
+
# a letter or digit. * The maximum length of a label name is 100 characters. For
|
|
1731
|
+
# example, the `appengine.googleapis.com/http/server/response_latencies` metric
|
|
1732
|
+
# type has a label for the HTTP response code, `response_code`, so you can look
|
|
1733
|
+
# at latencies for successful responses or just for responses that failed.
|
|
2005
1734
|
# Corresponds to the JSON property `labels`
|
|
2006
1735
|
# @return [Array<Google::Apis::ServiceconsumermanagementV1::LabelDescriptor>]
|
|
2007
1736
|
attr_accessor :labels
|
|
@@ -2016,17 +1745,16 @@ module Google
|
|
|
2016
1745
|
# @return [Google::Apis::ServiceconsumermanagementV1::MetricDescriptorMetadata]
|
|
2017
1746
|
attr_accessor :metadata
|
|
2018
1747
|
|
|
2019
|
-
# Whether the metric records instantaneous values, changes to a value, etc.
|
|
2020
|
-
#
|
|
1748
|
+
# Whether the metric records instantaneous values, changes to a value, etc. Some
|
|
1749
|
+
# combinations of `metric_kind` and `value_type` might not be supported.
|
|
2021
1750
|
# Corresponds to the JSON property `metricKind`
|
|
2022
1751
|
# @return [String]
|
|
2023
1752
|
attr_accessor :metric_kind
|
|
2024
1753
|
|
|
2025
|
-
# Read-only. If present, then a time
|
|
2026
|
-
#
|
|
2027
|
-
#
|
|
2028
|
-
#
|
|
2029
|
-
# resource types listed here.
|
|
1754
|
+
# Read-only. If present, then a time series, which is identified partially by a
|
|
1755
|
+
# metric type and a MonitoredResourceDescriptor, that is associated with this
|
|
1756
|
+
# metric type can only be associated with one of the monitored resource types
|
|
1757
|
+
# listed here.
|
|
2030
1758
|
# Corresponds to the JSON property `monitoredResourceTypes`
|
|
2031
1759
|
# @return [Array<String>]
|
|
2032
1760
|
attr_accessor :monitored_resource_types
|
|
@@ -2036,116 +1764,73 @@ module Google
|
|
|
2036
1764
|
# @return [String]
|
|
2037
1765
|
attr_accessor :name
|
|
2038
1766
|
|
|
2039
|
-
# The metric type, including its DNS name prefix. The type is not
|
|
2040
|
-
# URL-encoded.
|
|
1767
|
+
# The metric type, including its DNS name prefix. The type is not URL-encoded.
|
|
2041
1768
|
# All service defined metrics must be prefixed with the service name, in the
|
|
2042
|
-
# format of ``service name`/`relative metric name``, such as
|
|
2043
|
-
#
|
|
2044
|
-
# name must follow:
|
|
1769
|
+
# format of ``service name`/`relative metric name``, such as `cloudsql.
|
|
1770
|
+
# googleapis.com/database/cpu/utilization`. The relative metric name must follow:
|
|
2045
1771
|
# * Only upper and lower-case letters, digits, '/' and underscores '_' are
|
|
2046
|
-
# allowed.
|
|
2047
|
-
#
|
|
2048
|
-
#
|
|
2049
|
-
#
|
|
2050
|
-
#
|
|
2051
|
-
#
|
|
2052
|
-
# Metric types should use a natural hierarchical grouping. For example:
|
|
2053
|
-
# "custom.googleapis.com/invoice/paid/amount"
|
|
2054
|
-
# "external.googleapis.com/prometheus/up"
|
|
2055
|
-
# "appengine.googleapis.com/http/server/response_latencies"
|
|
1772
|
+
# allowed. * The maximum number of characters allowed for the
|
|
1773
|
+
# relative_metric_name is 100. All user-defined metric types have the DNS name `
|
|
1774
|
+
# custom.googleapis.com`, `external.googleapis.com`, or `logging.googleapis.com/
|
|
1775
|
+
# user/`. Metric types should use a natural hierarchical grouping. For example: "
|
|
1776
|
+
# custom.googleapis.com/invoice/paid/amount" "external.googleapis.com/prometheus/
|
|
1777
|
+
# up" "appengine.googleapis.com/http/server/response_latencies"
|
|
2056
1778
|
# Corresponds to the JSON property `type`
|
|
2057
1779
|
# @return [String]
|
|
2058
1780
|
attr_accessor :type
|
|
2059
1781
|
|
|
2060
|
-
# The units in which the metric value is reported. It is only applicable
|
|
2061
|
-
#
|
|
2062
|
-
#
|
|
2063
|
-
#
|
|
2064
|
-
# value of `
|
|
2065
|
-
#
|
|
2066
|
-
#
|
|
2067
|
-
#
|
|
2068
|
-
#
|
|
2069
|
-
#
|
|
2070
|
-
# `
|
|
2071
|
-
#
|
|
2072
|
-
#
|
|
2073
|
-
#
|
|
2074
|
-
#
|
|
2075
|
-
#
|
|
2076
|
-
#
|
|
2077
|
-
#
|
|
2078
|
-
#
|
|
2079
|
-
# * `
|
|
2080
|
-
# * `
|
|
2081
|
-
# * `
|
|
2082
|
-
# * `
|
|
2083
|
-
# * `
|
|
2084
|
-
#
|
|
2085
|
-
#
|
|
2086
|
-
#
|
|
2087
|
-
#
|
|
2088
|
-
#
|
|
2089
|
-
#
|
|
2090
|
-
# * `
|
|
2091
|
-
#
|
|
2092
|
-
# * `
|
|
2093
|
-
#
|
|
2094
|
-
# * `
|
|
2095
|
-
#
|
|
2096
|
-
#
|
|
2097
|
-
#
|
|
2098
|
-
#
|
|
2099
|
-
#
|
|
2100
|
-
# *
|
|
2101
|
-
#
|
|
2102
|
-
#
|
|
2103
|
-
# * `
|
|
2104
|
-
#
|
|
2105
|
-
#
|
|
2106
|
-
# * `Ti` tebi (2^40)
|
|
2107
|
-
# * `Pi` pebi (2^50)
|
|
2108
|
-
# **Grammar**
|
|
2109
|
-
# The grammar also includes these connectors:
|
|
2110
|
-
# * `/` division or ratio (as an infix operator). For examples,
|
|
2111
|
-
# `kBy/`email`` or `MiBy/10ms` (although you should almost never
|
|
2112
|
-
# have `/s` in a metric `unit`; rates should always be computed at
|
|
2113
|
-
# query time from the underlying cumulative or delta value).
|
|
2114
|
-
# * `.` multiplication or composition (as an infix operator). For
|
|
2115
|
-
# examples, `GBy.d` or `k`watt`.h`.
|
|
2116
|
-
# The grammar for a unit is as follows:
|
|
2117
|
-
# Expression = Component ` "." Component ` ` "/" Component ` ;
|
|
2118
|
-
# Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ]
|
|
2119
|
-
# | Annotation
|
|
2120
|
-
# | "1"
|
|
2121
|
-
# ;
|
|
2122
|
-
# Annotation = "`" NAME "`" ;
|
|
2123
|
-
# Notes:
|
|
2124
|
-
# * `Annotation` is just a comment if it follows a `UNIT`. If the annotation
|
|
2125
|
-
# is used alone, then the unit is equivalent to `1`. For examples,
|
|
2126
|
-
# ``request`/s == 1/s`, `By`transmitted`/s == By/s`.
|
|
2127
|
-
# * `NAME` is a sequence of non-blank printable ASCII characters not
|
|
2128
|
-
# containing ``` or ```.
|
|
2129
|
-
# * `1` represents a unitary [dimensionless
|
|
2130
|
-
# unit](https://en.wikipedia.org/wiki/Dimensionless_quantity) of 1, such
|
|
2131
|
-
# as in `1/s`. It is typically used when none of the basic units are
|
|
2132
|
-
# appropriate. For example, "new users per day" can be represented as
|
|
2133
|
-
# `1/d` or ``new-users`/d` (and a metric value `5` would mean "5 new
|
|
2134
|
-
# users). Alternatively, "thousands of page views per day" would be
|
|
2135
|
-
# represented as `1000/d` or `k1/d` or `k`page_views`/d` (and a metric
|
|
2136
|
-
# value of `5.3` would mean "5300 page views per day").
|
|
2137
|
-
# * `%` represents dimensionless value of 1/100, and annotates values giving
|
|
2138
|
-
# a percentage (so the metric values are typically in the range of 0..100,
|
|
2139
|
-
# and a metric value `3` means "3 percent").
|
|
2140
|
-
# * `10^2.%` indicates a metric contains a ratio, typically in the range
|
|
2141
|
-
# 0..1, that will be multiplied by 100 and displayed as a percentage
|
|
2142
|
-
# (so a metric value `0.03` means "3 percent").
|
|
1782
|
+
# The units in which the metric value is reported. It is only applicable if the `
|
|
1783
|
+
# value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The `unit` defines the
|
|
1784
|
+
# representation of the stored metric values. Different systems may scale the
|
|
1785
|
+
# values to be more easily displayed (so a value of `0.02KBy` _might_ be
|
|
1786
|
+
# displayed as `20By`, and a value of `3523KBy` _might_ be displayed as `3.5MBy`)
|
|
1787
|
+
# . However, if the `unit` is `KBy`, then the value of the metric is always in
|
|
1788
|
+
# thousands of bytes, no matter how it may be displayed.. If you want a custom
|
|
1789
|
+
# metric to record the exact number of CPU-seconds used by a job, you can create
|
|
1790
|
+
# an `INT64 CUMULATIVE` metric whose `unit` is `s`CPU`` (or equivalently `1s`CPU`
|
|
1791
|
+
# ` or just `s`). If the job uses 12,005 CPU-seconds, then the value is written
|
|
1792
|
+
# as `12005`. Alternatively, if you want a custom metric to record data in a
|
|
1793
|
+
# more granular way, you can create a `DOUBLE CUMULATIVE` metric whose `unit` is
|
|
1794
|
+
# `ks`CPU``, and then write the value `12.005` (which is `12005/1000`), or use `
|
|
1795
|
+
# Kis`CPU`` and write `11.723` (which is `12005/1024`). The supported units are
|
|
1796
|
+
# a subset of [The Unified Code for Units of Measure](http://unitsofmeasure.org/
|
|
1797
|
+
# ucum.html) standard: **Basic units (UNIT)** * `bit` bit * `By` byte * `s`
|
|
1798
|
+
# second * `min` minute * `h` hour * `d` day * `1` dimensionless **Prefixes (
|
|
1799
|
+
# PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga (10^9) * `T` tera (10^
|
|
1800
|
+
# 12) * `P` peta (10^15) * `E` exa (10^18) * `Z` zetta (10^21) * `Y` yotta (10^
|
|
1801
|
+
# 24) * `m` milli (10^-3) * `u` micro (10^-6) * `n` nano (10^-9) * `p` pico (10^-
|
|
1802
|
+
# 12) * `f` femto (10^-15) * `a` atto (10^-18) * `z` zepto (10^-21) * `y` yocto (
|
|
1803
|
+
# 10^-24) * `Ki` kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (
|
|
1804
|
+
# 2^40) * `Pi` pebi (2^50) **Grammar** The grammar also includes these
|
|
1805
|
+
# connectors: * `/` division or ratio (as an infix operator). For examples, `kBy/
|
|
1806
|
+
# `email`` or `MiBy/10ms` (although you should almost never have `/s` in a
|
|
1807
|
+
# metric `unit`; rates should always be computed at query time from the
|
|
1808
|
+
# underlying cumulative or delta value). * `.` multiplication or composition (as
|
|
1809
|
+
# an infix operator). For examples, `GBy.d` or `k`watt`.h`. The grammar for a
|
|
1810
|
+
# unit is as follows: Expression = Component ` "." Component ` ` "/" Component `
|
|
1811
|
+
# ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ;
|
|
1812
|
+
# Annotation = "`" NAME "`" ; Notes: * `Annotation` is just a comment if it
|
|
1813
|
+
# follows a `UNIT`. If the annotation is used alone, then the unit is equivalent
|
|
1814
|
+
# to `1`. For examples, ``request`/s == 1/s`, `By`transmitted`/s == By/s`. * `
|
|
1815
|
+
# NAME` is a sequence of non-blank printable ASCII characters not containing ```
|
|
1816
|
+
# or ```. * `1` represents a unitary [dimensionless unit](https://en.wikipedia.
|
|
1817
|
+
# org/wiki/Dimensionless_quantity) of 1, such as in `1/s`. It is typically used
|
|
1818
|
+
# when none of the basic units are appropriate. For example, "new users per day"
|
|
1819
|
+
# can be represented as `1/d` or ``new-users`/d` (and a metric value `5` would
|
|
1820
|
+
# mean "5 new users). Alternatively, "thousands of page views per day" would be
|
|
1821
|
+
# represented as `1000/d` or `k1/d` or `k`page_views`/d` (and a metric value of `
|
|
1822
|
+
# 5.3` would mean "5300 page views per day"). * `%` represents dimensionless
|
|
1823
|
+
# value of 1/100, and annotates values giving a percentage (so the metric values
|
|
1824
|
+
# are typically in the range of 0..100, and a metric value `3` means "3 percent")
|
|
1825
|
+
# . * `10^2.%` indicates a metric contains a ratio, typically in the range 0..1,
|
|
1826
|
+
# that will be multiplied by 100 and displayed as a percentage (so a metric
|
|
1827
|
+
# value `0.03` means "3 percent").
|
|
2143
1828
|
# Corresponds to the JSON property `unit`
|
|
2144
1829
|
# @return [String]
|
|
2145
1830
|
attr_accessor :unit
|
|
2146
1831
|
|
|
2147
|
-
# Whether the measurement is an integer, a floating-point number, etc.
|
|
2148
|
-
#
|
|
1832
|
+
# Whether the measurement is an integer, a floating-point number, etc. Some
|
|
1833
|
+
# combinations of `metric_kind` and `value_type` might not be supported.
|
|
2149
1834
|
# Corresponds to the JSON property `valueType`
|
|
2150
1835
|
# @return [String]
|
|
2151
1836
|
attr_accessor :value_type
|
|
@@ -2174,9 +1859,9 @@ module Google
|
|
|
2174
1859
|
class MetricDescriptorMetadata
|
|
2175
1860
|
include Google::Apis::Core::Hashable
|
|
2176
1861
|
|
|
2177
|
-
# The delay of data points caused by ingestion. Data points older than this
|
|
2178
|
-
#
|
|
2179
|
-
#
|
|
1862
|
+
# The delay of data points caused by ingestion. Data points older than this age
|
|
1863
|
+
# are guaranteed to be ingested and available to be read, excluding data loss
|
|
1864
|
+
# due to errors.
|
|
2180
1865
|
# Corresponds to the JSON property `ingestDelay`
|
|
2181
1866
|
# @return [String]
|
|
2182
1867
|
attr_accessor :ingest_delay
|
|
@@ -2188,8 +1873,8 @@ module Google
|
|
|
2188
1873
|
|
|
2189
1874
|
# The sampling period of metric data points. For metrics which are written
|
|
2190
1875
|
# periodically, consecutive data points are stored at this time interval,
|
|
2191
|
-
# excluding data loss due to errors. Metrics with a higher granularity have
|
|
2192
|
-
#
|
|
1876
|
+
# excluding data loss due to errors. Metrics with a higher granularity have a
|
|
1877
|
+
# smaller sampling period.
|
|
2193
1878
|
# Corresponds to the JSON property `samplePeriod`
|
|
2194
1879
|
# @return [String]
|
|
2195
1880
|
attr_accessor :sample_period
|
|
@@ -2206,22 +1891,21 @@ module Google
|
|
|
2206
1891
|
end
|
|
2207
1892
|
end
|
|
2208
1893
|
|
|
2209
|
-
# Bind API methods to metrics. Binding a method to a metric causes that
|
|
2210
|
-
#
|
|
1894
|
+
# Bind API methods to metrics. Binding a method to a metric causes that metric's
|
|
1895
|
+
# configured quota behaviors to apply to the method call.
|
|
2211
1896
|
class MetricRule
|
|
2212
1897
|
include Google::Apis::Core::Hashable
|
|
2213
1898
|
|
|
2214
1899
|
# Metrics to update when the selected methods are called, and the associated
|
|
2215
|
-
# cost applied to each metric.
|
|
2216
|
-
#
|
|
2217
|
-
#
|
|
2218
|
-
# The value must not be negative.
|
|
1900
|
+
# cost applied to each metric. The key of the map is the metric name, and the
|
|
1901
|
+
# values are the amount increased for the metric against which the quota limits
|
|
1902
|
+
# are defined. The value must not be negative.
|
|
2219
1903
|
# Corresponds to the JSON property `metricCosts`
|
|
2220
1904
|
# @return [Hash<String,Fixnum>]
|
|
2221
1905
|
attr_accessor :metric_costs
|
|
2222
1906
|
|
|
2223
|
-
# Selects the methods to which this rule applies.
|
|
2224
|
-
#
|
|
1907
|
+
# Selects the methods to which this rule applies. Refer to selector for syntax
|
|
1908
|
+
# details.
|
|
2225
1909
|
# Corresponds to the JSON property `selector`
|
|
2226
1910
|
# @return [String]
|
|
2227
1911
|
attr_accessor :selector
|
|
@@ -2239,66 +1923,33 @@ module Google
|
|
|
2239
1923
|
|
|
2240
1924
|
# Declares an API Interface to be included in this interface. The including
|
|
2241
1925
|
# interface must redeclare all the methods from the included interface, but
|
|
2242
|
-
# documentation and options are inherited as follows:
|
|
2243
|
-
#
|
|
2244
|
-
#
|
|
2245
|
-
#
|
|
2246
|
-
#
|
|
2247
|
-
#
|
|
2248
|
-
#
|
|
2249
|
-
#
|
|
2250
|
-
#
|
|
2251
|
-
#
|
|
2252
|
-
#
|
|
2253
|
-
#
|
|
2254
|
-
#
|
|
2255
|
-
#
|
|
2256
|
-
#
|
|
2257
|
-
#
|
|
2258
|
-
#
|
|
2259
|
-
# `
|
|
2260
|
-
# `
|
|
2261
|
-
#
|
|
2262
|
-
#
|
|
2263
|
-
#
|
|
2264
|
-
#
|
|
2265
|
-
#
|
|
2266
|
-
#
|
|
2267
|
-
# `
|
|
2268
|
-
# `
|
|
2269
|
-
# Example of a mixin configuration:
|
|
2270
|
-
# apis:
|
|
2271
|
-
# - name: google.storage.v2.Storage
|
|
2272
|
-
# mixins:
|
|
2273
|
-
# - name: google.acl.v1.AccessControl
|
|
2274
|
-
# The mixin construct implies that all methods in `AccessControl` are
|
|
2275
|
-
# also declared with same name and request/response types in
|
|
2276
|
-
# `Storage`. A documentation generator or annotation processor will
|
|
2277
|
-
# see the effective `Storage.GetAcl` method after inherting
|
|
2278
|
-
# documentation and annotations as follows:
|
|
2279
|
-
# service Storage `
|
|
2280
|
-
# // Get the underlying ACL object.
|
|
2281
|
-
# rpc GetAcl(GetAclRequest) returns (Acl) `
|
|
2282
|
-
# option (google.api.http).get = "/v2/`resource=**`:getAcl";
|
|
2283
|
-
# `
|
|
2284
|
-
# ...
|
|
2285
|
-
# `
|
|
2286
|
-
# Note how the version in the path pattern changed from `v1` to `v2`.
|
|
2287
|
-
# If the `root` field in the mixin is specified, it should be a
|
|
2288
|
-
# relative path under which inherited HTTP paths are placed. Example:
|
|
2289
|
-
# apis:
|
|
2290
|
-
# - name: google.storage.v2.Storage
|
|
2291
|
-
# mixins:
|
|
2292
|
-
# - name: google.acl.v1.AccessControl
|
|
2293
|
-
# root: acls
|
|
2294
|
-
# This implies the following inherited HTTP annotation:
|
|
2295
|
-
# service Storage `
|
|
2296
|
-
# // Get the underlying ACL object.
|
|
2297
|
-
# rpc GetAcl(GetAclRequest) returns (Acl) `
|
|
2298
|
-
# option (google.api.http).get = "/v2/acls/`resource=**`:getAcl";
|
|
2299
|
-
# `
|
|
2300
|
-
# ...
|
|
2301
|
-
# `
|
|
1926
|
+
# documentation and options are inherited as follows: - If after comment and
|
|
1927
|
+
# whitespace stripping, the documentation string of the redeclared method is
|
|
1928
|
+
# empty, it will be inherited from the original method. - Each annotation
|
|
1929
|
+
# belonging to the service config (http, visibility) which is not set in the
|
|
1930
|
+
# redeclared method will be inherited. - If an http annotation is inherited, the
|
|
1931
|
+
# path pattern will be modified as follows. Any version prefix will be replaced
|
|
1932
|
+
# by the version of the including interface plus the root path if specified.
|
|
1933
|
+
# Example of a simple mixin: package google.acl.v1; service AccessControl ` //
|
|
1934
|
+
# Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) `
|
|
1935
|
+
# option (google.api.http).get = "/v1/`resource=**`:getAcl"; ` ` package google.
|
|
1936
|
+
# storage.v2; service Storage ` // rpc GetAcl(GetAclRequest) returns (Acl); //
|
|
1937
|
+
# Get a data record. rpc GetData(GetDataRequest) returns (Data) ` option (google.
|
|
1938
|
+
# api.http).get = "/v2/`resource=**`"; ` ` Example of a mixin configuration:
|
|
1939
|
+
# apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.
|
|
1940
|
+
# AccessControl The mixin construct implies that all methods in `AccessControl`
|
|
1941
|
+
# are also declared with same name and request/response types in `Storage`. A
|
|
1942
|
+
# documentation generator or annotation processor will see the effective `
|
|
1943
|
+
# Storage.GetAcl` method after inherting documentation and annotations as
|
|
1944
|
+
# follows: service Storage ` // Get the underlying ACL object. rpc GetAcl(
|
|
1945
|
+
# GetAclRequest) returns (Acl) ` option (google.api.http).get = "/v2/`resource=**
|
|
1946
|
+
# `:getAcl"; ` ... ` Note how the version in the path pattern changed from `v1`
|
|
1947
|
+
# to `v2`. If the `root` field in the mixin is specified, it should be a
|
|
1948
|
+
# relative path under which inherited HTTP paths are placed. Example: apis: -
|
|
1949
|
+
# name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl
|
|
1950
|
+
# root: acls This implies the following inherited HTTP annotation: service
|
|
1951
|
+
# Storage ` // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (
|
|
1952
|
+
# Acl) ` option (google.api.http).get = "/v2/acls/`resource=**`:getAcl"; ` ... `
|
|
2302
1953
|
class Mixin
|
|
2303
1954
|
include Google::Apis::Core::Hashable
|
|
2304
1955
|
|
|
@@ -2307,8 +1958,7 @@ module Google
|
|
|
2307
1958
|
# @return [String]
|
|
2308
1959
|
attr_accessor :name
|
|
2309
1960
|
|
|
2310
|
-
# If non-empty specifies a path under which inherited HTTP paths
|
|
2311
|
-
# are rooted.
|
|
1961
|
+
# If non-empty specifies a path under which inherited HTTP paths are rooted.
|
|
2312
1962
|
# Corresponds to the JSON property `root`
|
|
2313
1963
|
# @return [String]
|
|
2314
1964
|
attr_accessor :root
|
|
@@ -2324,51 +1974,42 @@ module Google
|
|
|
2324
1974
|
end
|
|
2325
1975
|
end
|
|
2326
1976
|
|
|
2327
|
-
# An object that describes the schema of a MonitoredResource object using a
|
|
2328
|
-
#
|
|
2329
|
-
#
|
|
2330
|
-
#
|
|
2331
|
-
#
|
|
2332
|
-
#
|
|
2333
|
-
#
|
|
2334
|
-
#
|
|
2335
|
-
#
|
|
2336
|
-
#
|
|
2337
|
-
#
|
|
2338
|
-
#
|
|
2339
|
-
#
|
|
2340
|
-
#
|
|
2341
|
-
# * Maximum of default 5 service defined monitored resource descriptors
|
|
2342
|
-
# is allowed per service.
|
|
2343
|
-
# * Maximum of default 10 labels per monitored resource is allowed.
|
|
2344
|
-
# The default maximum limit can be overridden. Please follow
|
|
2345
|
-
# https://cloud.google.com/monitoring/quotas
|
|
1977
|
+
# An object that describes the schema of a MonitoredResource object using a type
|
|
1978
|
+
# name and a set of labels. For example, the monitored resource descriptor for
|
|
1979
|
+
# Google Compute Engine VM instances has a type of `"gce_instance"` and
|
|
1980
|
+
# specifies the use of the labels `"instance_id"` and `"zone"` to identify
|
|
1981
|
+
# particular VM instances. Different services can support different monitored
|
|
1982
|
+
# resource types. The following are specific rules to service defined monitored
|
|
1983
|
+
# resources for Monitoring and Logging: * The `type`, `display_name`, `
|
|
1984
|
+
# description`, `labels` and `launch_stage` fields are all required. * The first
|
|
1985
|
+
# label of the monitored resource descriptor must be `resource_container`. There
|
|
1986
|
+
# are legacy monitored resource descritptors start with `project_id`. * It must
|
|
1987
|
+
# include a `location` label. * Maximum of default 5 service defined monitored
|
|
1988
|
+
# resource descriptors is allowed per service. * Maximum of default 10 labels
|
|
1989
|
+
# per monitored resource is allowed. The default maximum limit can be overridden.
|
|
1990
|
+
# Please follow https://cloud.google.com/monitoring/quotas
|
|
2346
1991
|
class MonitoredResourceDescriptor
|
|
2347
1992
|
include Google::Apis::Core::Hashable
|
|
2348
1993
|
|
|
2349
|
-
# Optional. A detailed description of the monitored resource type that might
|
|
2350
|
-
#
|
|
1994
|
+
# Optional. A detailed description of the monitored resource type that might be
|
|
1995
|
+
# used in documentation.
|
|
2351
1996
|
# Corresponds to the JSON property `description`
|
|
2352
1997
|
# @return [String]
|
|
2353
1998
|
attr_accessor :description
|
|
2354
1999
|
|
|
2355
2000
|
# Optional. A concise name for the monitored resource type that might be
|
|
2356
|
-
# displayed in user interfaces. It should be a Title Cased Noun Phrase,
|
|
2357
|
-
#
|
|
2358
|
-
# `"Google Cloud SQL Database"`.
|
|
2001
|
+
# displayed in user interfaces. It should be a Title Cased Noun Phrase, without
|
|
2002
|
+
# any article or other determiners. For example, `"Google Cloud SQL Database"`.
|
|
2359
2003
|
# Corresponds to the JSON property `displayName`
|
|
2360
2004
|
# @return [String]
|
|
2361
2005
|
attr_accessor :display_name
|
|
2362
2006
|
|
|
2363
2007
|
# Required. A set of labels used to describe instances of this monitored
|
|
2364
|
-
# resource type.
|
|
2365
|
-
#
|
|
2366
|
-
# *
|
|
2367
|
-
#
|
|
2368
|
-
#
|
|
2369
|
-
# * The maximum length of a label name is 100 characters.
|
|
2370
|
-
# For example, an individual Google Cloud SQL database is
|
|
2371
|
-
# identified by values for the labels `database_id` and `location`.
|
|
2008
|
+
# resource type. The label key name must follow: * Only upper and lower-case
|
|
2009
|
+
# letters, digits and underscores (_) are allowed. * Label name must start with
|
|
2010
|
+
# a letter or digit. * The maximum length of a label name is 100 characters. For
|
|
2011
|
+
# example, an individual Google Cloud SQL database is identified by values for
|
|
2012
|
+
# the labels `database_id` and `location`.
|
|
2372
2013
|
# Corresponds to the JSON property `labels`
|
|
2373
2014
|
# @return [Array<Google::Apis::ServiceconsumermanagementV1::LabelDescriptor>]
|
|
2374
2015
|
attr_accessor :labels
|
|
@@ -2378,27 +2019,25 @@ module Google
|
|
|
2378
2019
|
# @return [String]
|
|
2379
2020
|
attr_accessor :launch_stage
|
|
2380
2021
|
|
|
2381
|
-
# Optional. The resource name of the monitored resource descriptor:
|
|
2382
|
-
#
|
|
2383
|
-
# `type`
|
|
2384
|
-
#
|
|
2385
|
-
#
|
|
2386
|
-
#
|
|
2022
|
+
# Optional. The resource name of the monitored resource descriptor: `"projects/`
|
|
2023
|
+
# project_id`/monitoredResourceDescriptors/`type`"` where `type` is the value of
|
|
2024
|
+
# the `type` field in this object and `project_id` is a project ID that provides
|
|
2025
|
+
# API-specific context for accessing the type. APIs that do not use project
|
|
2026
|
+
# information can use the resource name format `"monitoredResourceDescriptors/`
|
|
2027
|
+
# type`"`.
|
|
2387
2028
|
# Corresponds to the JSON property `name`
|
|
2388
2029
|
# @return [String]
|
|
2389
2030
|
attr_accessor :name
|
|
2390
2031
|
|
|
2391
|
-
# Required. The monitored resource type. For example, the type
|
|
2392
|
-
#
|
|
2393
|
-
#
|
|
2394
|
-
#
|
|
2395
|
-
#
|
|
2396
|
-
#
|
|
2397
|
-
#
|
|
2398
|
-
#
|
|
2399
|
-
#
|
|
2400
|
-
# is 100.
|
|
2401
|
-
# Note there are legacy service monitored resources not following this rule.
|
|
2032
|
+
# Required. The monitored resource type. For example, the type `
|
|
2033
|
+
# cloudsql_database` represents databases in Google Cloud SQL. All service
|
|
2034
|
+
# defined monitored resource types must be prefixed with the service name, in
|
|
2035
|
+
# the format of ``service name`/`relative resource name``. The relative resource
|
|
2036
|
+
# name must follow: * Only upper and lower-case letters and digits are allowed. *
|
|
2037
|
+
# It must start with upper case character and is recommended to use Upper Camel
|
|
2038
|
+
# Case style. * The maximum number of characters allowed for the
|
|
2039
|
+
# relative_resource_name is 100. Note there are legacy service monitored
|
|
2040
|
+
# resources not following this rule.
|
|
2402
2041
|
# Corresponds to the JSON property `type`
|
|
2403
2042
|
# @return [String]
|
|
2404
2043
|
attr_accessor :type
|
|
@@ -2418,75 +2057,47 @@ module Google
|
|
|
2418
2057
|
end
|
|
2419
2058
|
end
|
|
2420
2059
|
|
|
2421
|
-
# Monitoring configuration of the service.
|
|
2422
|
-
#
|
|
2423
|
-
#
|
|
2424
|
-
#
|
|
2425
|
-
#
|
|
2426
|
-
#
|
|
2427
|
-
#
|
|
2428
|
-
#
|
|
2429
|
-
# -
|
|
2430
|
-
#
|
|
2431
|
-
#
|
|
2432
|
-
#
|
|
2433
|
-
#
|
|
2434
|
-
# - key:
|
|
2435
|
-
#
|
|
2436
|
-
#
|
|
2437
|
-
#
|
|
2438
|
-
#
|
|
2439
|
-
#
|
|
2440
|
-
#
|
|
2441
|
-
#
|
|
2442
|
-
#
|
|
2443
|
-
# description: "The count of books that have been returned."
|
|
2444
|
-
# launch_stage: GA
|
|
2445
|
-
# metric_kind: DELTA
|
|
2446
|
-
# value_type: INT64
|
|
2447
|
-
# unit: "1"
|
|
2448
|
-
# labels:
|
|
2449
|
-
# - key: customer_id
|
|
2450
|
-
# description: "The id of the customer."
|
|
2451
|
-
# - name: library.googleapis.com/book/num_overdue
|
|
2452
|
-
# display_name: "Books Overdue"
|
|
2453
|
-
# description: "The current number of overdue books."
|
|
2454
|
-
# launch_stage: GA
|
|
2455
|
-
# metric_kind: GAUGE
|
|
2456
|
-
# value_type: INT64
|
|
2457
|
-
# unit: "1"
|
|
2458
|
-
# labels:
|
|
2459
|
-
# - key: customer_id
|
|
2460
|
-
# description: "The id of the customer."
|
|
2461
|
-
# monitoring:
|
|
2462
|
-
# producer_destinations:
|
|
2463
|
-
# - monitored_resource: library.googleapis.com/Branch
|
|
2464
|
-
# metrics:
|
|
2465
|
-
# - library.googleapis.com/book/returned_count
|
|
2466
|
-
# consumer_destinations:
|
|
2467
|
-
# - monitored_resource: library.googleapis.com/Branch
|
|
2468
|
-
# metrics:
|
|
2469
|
-
# - library.googleapis.com/book/returned_count
|
|
2470
|
-
# - library.googleapis.com/book/num_overdue
|
|
2060
|
+
# Monitoring configuration of the service. The example below shows how to
|
|
2061
|
+
# configure monitored resources and metrics for monitoring. In the example, a
|
|
2062
|
+
# monitored resource and two metrics are defined. The `library.googleapis.com/
|
|
2063
|
+
# book/returned_count` metric is sent to both producer and consumer projects,
|
|
2064
|
+
# whereas the `library.googleapis.com/book/num_overdue` metric is only sent to
|
|
2065
|
+
# the consumer project. monitored_resources: - type: library.googleapis.com/
|
|
2066
|
+
# Branch display_name: "Library Branch" description: "A branch of a library."
|
|
2067
|
+
# launch_stage: GA labels: - key: resource_container description: "The Cloud
|
|
2068
|
+
# container (ie. project id) for the Branch." - key: location description: "The
|
|
2069
|
+
# location of the library branch." - key: branch_id description: "The id of the
|
|
2070
|
+
# branch." metrics: - name: library.googleapis.com/book/returned_count
|
|
2071
|
+
# display_name: "Books Returned" description: "The count of books that have been
|
|
2072
|
+
# returned." launch_stage: GA metric_kind: DELTA value_type: INT64 unit: "1"
|
|
2073
|
+
# labels: - key: customer_id description: "The id of the customer." - name:
|
|
2074
|
+
# library.googleapis.com/book/num_overdue display_name: "Books Overdue"
|
|
2075
|
+
# description: "The current number of overdue books." launch_stage: GA
|
|
2076
|
+
# metric_kind: GAUGE value_type: INT64 unit: "1" labels: - key: customer_id
|
|
2077
|
+
# description: "The id of the customer." monitoring: producer_destinations: -
|
|
2078
|
+
# monitored_resource: library.googleapis.com/Branch metrics: - library.
|
|
2079
|
+
# googleapis.com/book/returned_count consumer_destinations: - monitored_resource:
|
|
2080
|
+
# library.googleapis.com/Branch metrics: - library.googleapis.com/book/
|
|
2081
|
+
# returned_count - library.googleapis.com/book/num_overdue
|
|
2471
2082
|
class Monitoring
|
|
2472
2083
|
include Google::Apis::Core::Hashable
|
|
2473
2084
|
|
|
2474
|
-
# Monitoring configurations for sending metrics to the consumer project.
|
|
2475
|
-
#
|
|
2476
|
-
#
|
|
2477
|
-
#
|
|
2478
|
-
#
|
|
2479
|
-
#
|
|
2085
|
+
# Monitoring configurations for sending metrics to the consumer project. There
|
|
2086
|
+
# can be multiple consumer destinations. A monitored resource type may appear in
|
|
2087
|
+
# multiple monitoring destinations if different aggregations are needed for
|
|
2088
|
+
# different sets of metrics associated with that monitored resource type. A
|
|
2089
|
+
# monitored resource and metric pair may only be used once in the Monitoring
|
|
2090
|
+
# configuration.
|
|
2480
2091
|
# Corresponds to the JSON property `consumerDestinations`
|
|
2481
2092
|
# @return [Array<Google::Apis::ServiceconsumermanagementV1::MonitoringDestination>]
|
|
2482
2093
|
attr_accessor :consumer_destinations
|
|
2483
2094
|
|
|
2484
|
-
# Monitoring configurations for sending metrics to the producer project.
|
|
2485
|
-
#
|
|
2486
|
-
#
|
|
2487
|
-
#
|
|
2488
|
-
#
|
|
2489
|
-
#
|
|
2095
|
+
# Monitoring configurations for sending metrics to the producer project. There
|
|
2096
|
+
# can be multiple producer destinations. A monitored resource type may appear in
|
|
2097
|
+
# multiple monitoring destinations if different aggregations are needed for
|
|
2098
|
+
# different sets of metrics associated with that monitored resource type. A
|
|
2099
|
+
# monitored resource and metric pair may only be used once in the Monitoring
|
|
2100
|
+
# configuration.
|
|
2490
2101
|
# Corresponds to the JSON property `producerDestinations`
|
|
2491
2102
|
# @return [Array<Google::Apis::ServiceconsumermanagementV1::MonitoringDestination>]
|
|
2492
2103
|
attr_accessor :producer_destinations
|
|
@@ -2502,19 +2113,19 @@ module Google
|
|
|
2502
2113
|
end
|
|
2503
2114
|
end
|
|
2504
2115
|
|
|
2505
|
-
# Configuration of a specific monitoring destination (the producer project
|
|
2506
|
-
#
|
|
2116
|
+
# Configuration of a specific monitoring destination (the producer project or
|
|
2117
|
+
# the consumer project).
|
|
2507
2118
|
class MonitoringDestination
|
|
2508
2119
|
include Google::Apis::Core::Hashable
|
|
2509
2120
|
|
|
2510
|
-
# Types of the metrics to report to this monitoring destination.
|
|
2511
|
-
#
|
|
2121
|
+
# Types of the metrics to report to this monitoring destination. Each type must
|
|
2122
|
+
# be defined in Service.metrics section.
|
|
2512
2123
|
# Corresponds to the JSON property `metrics`
|
|
2513
2124
|
# @return [Array<String>]
|
|
2514
2125
|
attr_accessor :metrics
|
|
2515
2126
|
|
|
2516
|
-
# The monitored resource type. The type must be defined in
|
|
2517
|
-
#
|
|
2127
|
+
# The monitored resource type. The type must be defined in Service.
|
|
2128
|
+
# monitored_resources section.
|
|
2518
2129
|
# Corresponds to the JSON property `monitoredResource`
|
|
2519
2130
|
# @return [String]
|
|
2520
2131
|
attr_accessor :monitored_resource
|
|
@@ -2531,27 +2142,25 @@ module Google
|
|
|
2531
2142
|
end
|
|
2532
2143
|
|
|
2533
2144
|
# OAuth scopes are a way to define data and permissions on data. For example,
|
|
2534
|
-
# there are scopes defined for "Read-only access to Google Calendar" and
|
|
2535
|
-
#
|
|
2536
|
-
#
|
|
2537
|
-
#
|
|
2538
|
-
#
|
|
2539
|
-
#
|
|
2540
|
-
#
|
|
2541
|
-
#
|
|
2542
|
-
#
|
|
2543
|
-
#
|
|
2544
|
-
#
|
|
2545
|
-
#
|
|
2546
|
-
# due to the backend requiring additional scopes or permissions.
|
|
2145
|
+
# there are scopes defined for "Read-only access to Google Calendar" and "Access
|
|
2146
|
+
# to Cloud Platform". Users can consent to a scope for an application, giving it
|
|
2147
|
+
# permission to access that data on their behalf. OAuth scope specifications
|
|
2148
|
+
# should be fairly coarse grained; a user will need to see and understand the
|
|
2149
|
+
# text description of what your scope means. In most cases: use one or at most
|
|
2150
|
+
# two OAuth scopes for an entire family of products. If your product has
|
|
2151
|
+
# multiple APIs, you should probably be sharing the OAuth scope across all of
|
|
2152
|
+
# those APIs. When you need finer grained OAuth consent screens: talk with your
|
|
2153
|
+
# product management about how developers will use them in practice. Please note
|
|
2154
|
+
# that even though each of the canonical scopes is enough for a request to be
|
|
2155
|
+
# accepted and passed to the backend, a request can still fail due to the
|
|
2156
|
+
# backend requiring additional scopes or permissions.
|
|
2547
2157
|
class OAuthRequirements
|
|
2548
2158
|
include Google::Apis::Core::Hashable
|
|
2549
2159
|
|
|
2550
|
-
# The list of publicly documented OAuth scopes that are allowed access. An
|
|
2551
|
-
#
|
|
2552
|
-
#
|
|
2553
|
-
#
|
|
2554
|
-
# https://www.googleapis.com/auth/calendar.read
|
|
2160
|
+
# The list of publicly documented OAuth scopes that are allowed access. An OAuth
|
|
2161
|
+
# token containing any of these scopes will be accepted. Example:
|
|
2162
|
+
# canonical_scopes: https://www.googleapis.com/auth/calendar, https://www.
|
|
2163
|
+
# googleapis.com/auth/calendar.read
|
|
2555
2164
|
# Corresponds to the JSON property `canonicalScopes`
|
|
2556
2165
|
# @return [String]
|
|
2557
2166
|
attr_accessor :canonical_scopes
|
|
@@ -2571,47 +2180,45 @@ module Google
|
|
|
2571
2180
|
class Operation
|
|
2572
2181
|
include Google::Apis::Core::Hashable
|
|
2573
2182
|
|
|
2574
|
-
# If the value is `false`, it means the operation is still in progress.
|
|
2575
|
-
#
|
|
2576
|
-
# available.
|
|
2183
|
+
# If the value is `false`, it means the operation is still in progress. If `true`
|
|
2184
|
+
# , the operation is completed, and either `error` or `response` is available.
|
|
2577
2185
|
# Corresponds to the JSON property `done`
|
|
2578
2186
|
# @return [Boolean]
|
|
2579
2187
|
attr_accessor :done
|
|
2580
2188
|
alias_method :done?, :done
|
|
2581
2189
|
|
|
2582
|
-
# The `Status` type defines a logical error model that is suitable for
|
|
2583
|
-
#
|
|
2584
|
-
#
|
|
2585
|
-
#
|
|
2586
|
-
#
|
|
2587
|
-
#
|
|
2190
|
+
# The `Status` type defines a logical error model that is suitable for different
|
|
2191
|
+
# programming environments, including REST APIs and RPC APIs. It is used by [
|
|
2192
|
+
# gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
|
|
2193
|
+
# data: error code, error message, and error details. You can find out more
|
|
2194
|
+
# about this error model and how to work with it in the [API Design Guide](https:
|
|
2195
|
+
# //cloud.google.com/apis/design/errors).
|
|
2588
2196
|
# Corresponds to the JSON property `error`
|
|
2589
2197
|
# @return [Google::Apis::ServiceconsumermanagementV1::Status]
|
|
2590
2198
|
attr_accessor :error
|
|
2591
2199
|
|
|
2592
|
-
# Service-specific metadata associated with the operation.
|
|
2593
|
-
#
|
|
2594
|
-
#
|
|
2595
|
-
#
|
|
2200
|
+
# Service-specific metadata associated with the operation. It typically contains
|
|
2201
|
+
# progress information and common metadata such as create time. Some services
|
|
2202
|
+
# might not provide such metadata. Any method that returns a long-running
|
|
2203
|
+
# operation should document the metadata type, if any.
|
|
2596
2204
|
# Corresponds to the JSON property `metadata`
|
|
2597
2205
|
# @return [Hash<String,Object>]
|
|
2598
2206
|
attr_accessor :metadata
|
|
2599
2207
|
|
|
2600
2208
|
# The server-assigned name, which is only unique within the same service that
|
|
2601
|
-
# originally returns it. If you use the default HTTP mapping, the
|
|
2602
|
-
#
|
|
2209
|
+
# originally returns it. If you use the default HTTP mapping, the `name` should
|
|
2210
|
+
# be a resource name ending with `operations/`unique_id``.
|
|
2603
2211
|
# Corresponds to the JSON property `name`
|
|
2604
2212
|
# @return [String]
|
|
2605
2213
|
attr_accessor :name
|
|
2606
2214
|
|
|
2607
|
-
# The normal response of the operation in case of success.
|
|
2608
|
-
# method returns no data on success, such as `Delete`, the response is
|
|
2609
|
-
#
|
|
2610
|
-
#
|
|
2611
|
-
#
|
|
2612
|
-
#
|
|
2613
|
-
#
|
|
2614
|
-
# `TakeSnapshotResponse`.
|
|
2215
|
+
# The normal response of the operation in case of success. If the original
|
|
2216
|
+
# method returns no data on success, such as `Delete`, the response is `google.
|
|
2217
|
+
# protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`,
|
|
2218
|
+
# the response should be the resource. For other methods, the response should
|
|
2219
|
+
# have the type `XxxResponse`, where `Xxx` is the original method name. For
|
|
2220
|
+
# example, if the original method name is `TakeSnapshot()`, the inferred
|
|
2221
|
+
# response type is `TakeSnapshotResponse`.
|
|
2615
2222
|
# Corresponds to the JSON property `response`
|
|
2616
2223
|
# @return [Hash<String,Object>]
|
|
2617
2224
|
attr_accessor :response
|
|
@@ -2636,17 +2243,17 @@ module Google
|
|
|
2636
2243
|
include Google::Apis::Core::Hashable
|
|
2637
2244
|
|
|
2638
2245
|
# The option's name. For protobuf built-in options (options defined in
|
|
2639
|
-
# descriptor.proto), this is the short name. For example, `"map_entry"`.
|
|
2640
|
-
#
|
|
2641
|
-
#
|
|
2246
|
+
# descriptor.proto), this is the short name. For example, `"map_entry"`. For
|
|
2247
|
+
# custom options, it should be the fully-qualified name. For example, `"google.
|
|
2248
|
+
# api.http"`.
|
|
2642
2249
|
# Corresponds to the JSON property `name`
|
|
2643
2250
|
# @return [String]
|
|
2644
2251
|
attr_accessor :name
|
|
2645
2252
|
|
|
2646
|
-
# The option's value packed in an Any message. If the value is a primitive,
|
|
2647
|
-
#
|
|
2648
|
-
#
|
|
2649
|
-
#
|
|
2253
|
+
# The option's value packed in an Any message. If the value is a primitive, the
|
|
2254
|
+
# corresponding wrapper type defined in google/protobuf/wrappers.proto should be
|
|
2255
|
+
# used. If the value is an enum, it should be stored as an int32 value using the
|
|
2256
|
+
# google.protobuf.Int32Value type.
|
|
2650
2257
|
# Corresponds to the JSON property `value`
|
|
2651
2258
|
# @return [Hash<String,Object>]
|
|
2652
2259
|
attr_accessor :value
|
|
@@ -2667,32 +2274,25 @@ module Google
|
|
|
2667
2274
|
class Page
|
|
2668
2275
|
include Google::Apis::Core::Hashable
|
|
2669
2276
|
|
|
2670
|
-
# The Markdown content of the page. You can use
|
|
2671
|
-
#
|
|
2277
|
+
# The Markdown content of the page. You can use (== include `path` ==) to
|
|
2278
|
+
# include content from a Markdown file.
|
|
2672
2279
|
# Corresponds to the JSON property `content`
|
|
2673
2280
|
# @return [String]
|
|
2674
2281
|
attr_accessor :content
|
|
2675
2282
|
|
|
2676
|
-
# The name of the page. It will be used as an identity of the page to
|
|
2677
|
-
#
|
|
2678
|
-
#
|
|
2679
|
-
#
|
|
2680
|
-
#
|
|
2681
|
-
#
|
|
2682
|
-
#
|
|
2683
|
-
# content: (== include tutorial.md ==)
|
|
2684
|
-
# subpages:
|
|
2685
|
-
# - name: Java
|
|
2686
|
-
# content: (== include tutorial_java.md ==)
|
|
2687
|
-
# </code></pre>
|
|
2688
|
-
# You can reference `Java` page using Markdown reference link syntax:
|
|
2689
|
-
# `Java`.
|
|
2283
|
+
# The name of the page. It will be used as an identity of the page to generate
|
|
2284
|
+
# URI of the page, text of the link to this page in navigation, etc. The full
|
|
2285
|
+
# page name (start from the root page name to this page concatenated with `.`)
|
|
2286
|
+
# can be used as reference to the page in your documentation. For example: pages:
|
|
2287
|
+
# - name: Tutorial content: (== include tutorial.md ==) subpages: - name: Java
|
|
2288
|
+
# content: (== include tutorial_java.md ==) You can reference `Java` page using
|
|
2289
|
+
# Markdown reference link syntax: `Java`.
|
|
2690
2290
|
# Corresponds to the JSON property `name`
|
|
2691
2291
|
# @return [String]
|
|
2692
2292
|
attr_accessor :name
|
|
2693
2293
|
|
|
2694
|
-
# Subpages of this page. The order of subpages specified here will be
|
|
2695
|
-
#
|
|
2294
|
+
# Subpages of this page. The order of subpages specified here will be honored in
|
|
2295
|
+
# the generated docset.
|
|
2696
2296
|
# Corresponds to the JSON property `subpages`
|
|
2697
2297
|
# @return [Array<Google::Apis::ServiceconsumermanagementV1::Page>]
|
|
2698
2298
|
attr_accessor :subpages
|
|
@@ -2713,15 +2313,15 @@ module Google
|
|
|
2713
2313
|
class PolicyBinding
|
|
2714
2314
|
include Google::Apis::Core::Hashable
|
|
2715
2315
|
|
|
2716
|
-
# Uses the same format as in IAM policy.
|
|
2717
|
-
#
|
|
2718
|
-
#
|
|
2316
|
+
# Uses the same format as in IAM policy. `member` must include both a prefix and
|
|
2317
|
+
# ID. For example, `user:`emailId``, `serviceAccount:`emailId``, `group:`emailId`
|
|
2318
|
+
# `.
|
|
2719
2319
|
# Corresponds to the JSON property `members`
|
|
2720
2320
|
# @return [Array<String>]
|
|
2721
2321
|
attr_accessor :members
|
|
2722
2322
|
|
|
2723
|
-
# Role. (https://cloud.google.com/iam/docs/understanding-roles)
|
|
2724
|
-
#
|
|
2323
|
+
# Role. (https://cloud.google.com/iam/docs/understanding-roles) For example, `
|
|
2324
|
+
# roles/viewer`, `roles/editor`, or `roles/owner`.
|
|
2725
2325
|
# Corresponds to the JSON property `role`
|
|
2726
2326
|
# @return [String]
|
|
2727
2327
|
attr_accessor :role
|
|
@@ -2737,46 +2337,25 @@ module Google
|
|
|
2737
2337
|
end
|
|
2738
2338
|
end
|
|
2739
2339
|
|
|
2740
|
-
# Quota configuration helps to achieve fairness and budgeting in service
|
|
2741
|
-
#
|
|
2742
|
-
#
|
|
2743
|
-
#
|
|
2744
|
-
#
|
|
2745
|
-
#
|
|
2746
|
-
#
|
|
2747
|
-
#
|
|
2748
|
-
#
|
|
2749
|
-
#
|
|
2750
|
-
#
|
|
2751
|
-
# -
|
|
2752
|
-
#
|
|
2753
|
-
#
|
|
2754
|
-
#
|
|
2755
|
-
#
|
|
2756
|
-
#
|
|
2757
|
-
#
|
|
2758
|
-
#
|
|
2759
|
-
# # consuming at twice rate as the DeleteBook method.
|
|
2760
|
-
# metric_rules:
|
|
2761
|
-
# - selector: "*"
|
|
2762
|
-
# metric_costs:
|
|
2763
|
-
# library.googleapis.com/read_calls: 1
|
|
2764
|
-
# - selector: google.example.library.v1.LibraryService.UpdateBook
|
|
2765
|
-
# metric_costs:
|
|
2766
|
-
# library.googleapis.com/write_calls: 2
|
|
2767
|
-
# - selector: google.example.library.v1.LibraryService.DeleteBook
|
|
2768
|
-
# metric_costs:
|
|
2769
|
-
# library.googleapis.com/write_calls: 1
|
|
2770
|
-
# Corresponding Metric definition:
|
|
2771
|
-
# metrics:
|
|
2772
|
-
# - name: library.googleapis.com/read_calls
|
|
2773
|
-
# display_name: Read requests
|
|
2774
|
-
# metric_kind: DELTA
|
|
2775
|
-
# value_type: INT64
|
|
2776
|
-
# - name: library.googleapis.com/write_calls
|
|
2777
|
-
# display_name: Write requests
|
|
2778
|
-
# metric_kind: DELTA
|
|
2779
|
-
# value_type: INT64
|
|
2340
|
+
# Quota configuration helps to achieve fairness and budgeting in service usage.
|
|
2341
|
+
# The metric based quota configuration works this way: - The service
|
|
2342
|
+
# configuration defines a set of metrics. - For API calls, the quota.
|
|
2343
|
+
# metric_rules maps methods to metrics with corresponding costs. - The quota.
|
|
2344
|
+
# limits defines limits on the metrics, which will be used for quota checks at
|
|
2345
|
+
# runtime. An example quota configuration in yaml format: quota: limits: - name:
|
|
2346
|
+
# apiWriteQpsPerProject metric: library.googleapis.com/write_calls unit: "1/min/`
|
|
2347
|
+
# project`" # rate limit for consumer projects values: STANDARD: 10000 # The
|
|
2348
|
+
# metric rules bind all methods to the read_calls metric, # except for the
|
|
2349
|
+
# UpdateBook and DeleteBook methods. These two methods # are mapped to the
|
|
2350
|
+
# write_calls metric, with the UpdateBook method # consuming at twice rate as
|
|
2351
|
+
# the DeleteBook method. metric_rules: - selector: "*" metric_costs: library.
|
|
2352
|
+
# googleapis.com/read_calls: 1 - selector: google.example.library.v1.
|
|
2353
|
+
# LibraryService.UpdateBook metric_costs: library.googleapis.com/write_calls: 2 -
|
|
2354
|
+
# selector: google.example.library.v1.LibraryService.DeleteBook metric_costs:
|
|
2355
|
+
# library.googleapis.com/write_calls: 1 Corresponding Metric definition: metrics:
|
|
2356
|
+
# - name: library.googleapis.com/read_calls display_name: Read requests
|
|
2357
|
+
# metric_kind: DELTA value_type: INT64 - name: library.googleapis.com/
|
|
2358
|
+
# write_calls display_name: Write requests metric_kind: DELTA value_type: INT64
|
|
2780
2359
|
class Quota
|
|
2781
2360
|
include Google::Apis::Core::Hashable
|
|
2782
2361
|
|
|
@@ -2785,8 +2364,8 @@ module Google
|
|
|
2785
2364
|
# @return [Array<Google::Apis::ServiceconsumermanagementV1::QuotaLimit>]
|
|
2786
2365
|
attr_accessor :limits
|
|
2787
2366
|
|
|
2788
|
-
# List of `MetricRule` definitions, each one mapping a selected method to one
|
|
2789
|
-
#
|
|
2367
|
+
# List of `MetricRule` definitions, each one mapping a selected method to one or
|
|
2368
|
+
# more metrics.
|
|
2790
2369
|
# Corresponds to the JSON property `metricRules`
|
|
2791
2370
|
# @return [Array<Google::Apis::ServiceconsumermanagementV1::MetricRule>]
|
|
2792
2371
|
attr_accessor :metric_rules
|
|
@@ -2803,95 +2382,89 @@ module Google
|
|
|
2803
2382
|
end
|
|
2804
2383
|
|
|
2805
2384
|
# `QuotaLimit` defines a specific limit that applies over a specified duration
|
|
2806
|
-
# for a limit type. There can be at most one limit for a duration and limit
|
|
2807
|
-
#
|
|
2385
|
+
# for a limit type. There can be at most one limit for a duration and limit type
|
|
2386
|
+
# combination defined within a `QuotaGroup`.
|
|
2808
2387
|
class QuotaLimit
|
|
2809
2388
|
include Google::Apis::Core::Hashable
|
|
2810
2389
|
|
|
2811
|
-
# Default number of tokens that can be consumed during the specified
|
|
2812
|
-
#
|
|
2813
|
-
#
|
|
2814
|
-
#
|
|
2815
|
-
#
|
|
2816
|
-
#
|
|
2817
|
-
#
|
|
2818
|
-
# Used by group-based quotas only.
|
|
2390
|
+
# Default number of tokens that can be consumed during the specified duration.
|
|
2391
|
+
# This is the number of tokens assigned when a client application developer
|
|
2392
|
+
# activates the service for his/her project. Specifying a value of 0 will block
|
|
2393
|
+
# all requests. This can be used if you are provisioning quota to selected
|
|
2394
|
+
# consumers and blocking others. Similarly, a value of -1 will indicate an
|
|
2395
|
+
# unlimited quota. No other negative values are allowed. Used by group-based
|
|
2396
|
+
# quotas only.
|
|
2819
2397
|
# Corresponds to the JSON property `defaultLimit`
|
|
2820
2398
|
# @return [Fixnum]
|
|
2821
2399
|
attr_accessor :default_limit
|
|
2822
2400
|
|
|
2823
|
-
# Optional. User-visible, extended description for this quota limit.
|
|
2824
|
-
#
|
|
2825
|
-
#
|
|
2401
|
+
# Optional. User-visible, extended description for this quota limit. Should be
|
|
2402
|
+
# used only when more context is needed to understand this limit than provided
|
|
2403
|
+
# by the limit's display name (see: `display_name`).
|
|
2826
2404
|
# Corresponds to the JSON property `description`
|
|
2827
2405
|
# @return [String]
|
|
2828
2406
|
attr_accessor :description
|
|
2829
2407
|
|
|
2830
|
-
# User-visible display name for this limit.
|
|
2831
|
-
#
|
|
2832
|
-
#
|
|
2833
|
-
#
|
|
2408
|
+
# User-visible display name for this limit. Optional. If not set, the UI will
|
|
2409
|
+
# provide a default display name based on the quota configuration. This field
|
|
2410
|
+
# can be used to override the default display name generated from the
|
|
2411
|
+
# configuration.
|
|
2834
2412
|
# Corresponds to the JSON property `displayName`
|
|
2835
2413
|
# @return [String]
|
|
2836
2414
|
attr_accessor :display_name
|
|
2837
2415
|
|
|
2838
|
-
# Duration of this limit in textual notation. Must be "100s" or "1d".
|
|
2839
|
-
#
|
|
2416
|
+
# Duration of this limit in textual notation. Must be "100s" or "1d". Used by
|
|
2417
|
+
# group-based quotas only.
|
|
2840
2418
|
# Corresponds to the JSON property `duration`
|
|
2841
2419
|
# @return [String]
|
|
2842
2420
|
attr_accessor :duration
|
|
2843
2421
|
|
|
2844
|
-
# Free tier value displayed in the Developers Console for this limit.
|
|
2845
|
-
#
|
|
2846
|
-
#
|
|
2847
|
-
#
|
|
2848
|
-
#
|
|
2849
|
-
#
|
|
2850
|
-
# Used by group-based quotas only.
|
|
2422
|
+
# Free tier value displayed in the Developers Console for this limit. The free
|
|
2423
|
+
# tier is the number of tokens that will be subtracted from the billed amount
|
|
2424
|
+
# when billing is enabled. This field can only be set on a limit with duration "
|
|
2425
|
+
# 1d", in a billable group; it is invalid on any other limit. If this field is
|
|
2426
|
+
# not set, it defaults to 0, indicating that there is no free tier for this
|
|
2427
|
+
# service. Used by group-based quotas only.
|
|
2851
2428
|
# Corresponds to the JSON property `freeTier`
|
|
2852
2429
|
# @return [Fixnum]
|
|
2853
2430
|
attr_accessor :free_tier
|
|
2854
2431
|
|
|
2855
|
-
# Maximum number of tokens that can be consumed during the specified
|
|
2856
|
-
#
|
|
2857
|
-
#
|
|
2858
|
-
#
|
|
2859
|
-
#
|
|
2860
|
-
#
|
|
2861
|
-
# Used by group-based quotas only.
|
|
2432
|
+
# Maximum number of tokens that can be consumed during the specified duration.
|
|
2433
|
+
# Client application developers can override the default limit up to this
|
|
2434
|
+
# maximum. If specified, this value cannot be set to a value less than the
|
|
2435
|
+
# default limit. If not specified, it is set to the default limit. To allow
|
|
2436
|
+
# clients to apply overrides with no upper bound, set this to -1, indicating
|
|
2437
|
+
# unlimited maximum quota. Used by group-based quotas only.
|
|
2862
2438
|
# Corresponds to the JSON property `maxLimit`
|
|
2863
2439
|
# @return [Fixnum]
|
|
2864
2440
|
attr_accessor :max_limit
|
|
2865
2441
|
|
|
2866
|
-
# The name of the metric this quota limit applies to. The quota limits with
|
|
2867
|
-
#
|
|
2442
|
+
# The name of the metric this quota limit applies to. The quota limits with the
|
|
2443
|
+
# same metric will be checked together during runtime. The metric must be
|
|
2868
2444
|
# defined within the service config.
|
|
2869
2445
|
# Corresponds to the JSON property `metric`
|
|
2870
2446
|
# @return [String]
|
|
2871
2447
|
attr_accessor :metric
|
|
2872
2448
|
|
|
2873
|
-
# Name of the quota limit.
|
|
2874
|
-
#
|
|
2875
|
-
#
|
|
2876
|
-
# The maximum length of the limit name is 64 characters.
|
|
2449
|
+
# Name of the quota limit. The name must be provided, and it must be unique
|
|
2450
|
+
# within the service. The name can only include alphanumeric characters as well
|
|
2451
|
+
# as '-'. The maximum length of the limit name is 64 characters.
|
|
2877
2452
|
# Corresponds to the JSON property `name`
|
|
2878
2453
|
# @return [String]
|
|
2879
2454
|
attr_accessor :name
|
|
2880
2455
|
|
|
2881
|
-
# Specify the unit of the quota limit. It uses the same syntax as
|
|
2882
|
-
#
|
|
2883
|
-
#
|
|
2884
|
-
#
|
|
2885
|
-
#
|
|
2886
|
-
# Note: the order of unit components is insignificant.
|
|
2887
|
-
# The "1" at the beginning is required to follow the metric unit syntax.
|
|
2456
|
+
# Specify the unit of the quota limit. It uses the same syntax as Metric.unit.
|
|
2457
|
+
# The supported unit kinds are determined by the quota backend system. Here are
|
|
2458
|
+
# some examples: * "1/min/`project`" for quota per minute per project. Note: the
|
|
2459
|
+
# order of unit components is insignificant. The "1" at the beginning is
|
|
2460
|
+
# required to follow the metric unit syntax.
|
|
2888
2461
|
# Corresponds to the JSON property `unit`
|
|
2889
2462
|
# @return [String]
|
|
2890
2463
|
attr_accessor :unit
|
|
2891
2464
|
|
|
2892
2465
|
# Tiered limit values. You must specify this as a key:value pair, with an
|
|
2893
|
-
# integer value that is the maximum number of requests allowed for the
|
|
2894
|
-
#
|
|
2466
|
+
# integer value that is the maximum number of requests allowed for the specified
|
|
2467
|
+
# unit. Currently only STANDARD is supported.
|
|
2895
2468
|
# Corresponds to the JSON property `values`
|
|
2896
2469
|
# @return [Hash<String,Fixnum>]
|
|
2897
2470
|
attr_accessor :values
|
|
@@ -2960,50 +2533,32 @@ module Google
|
|
|
2960
2533
|
end
|
|
2961
2534
|
|
|
2962
2535
|
# `Service` is the root object of Google service configuration schema. It
|
|
2963
|
-
# describes basic information about a service, such as the name and the
|
|
2964
|
-
#
|
|
2965
|
-
#
|
|
2966
|
-
#
|
|
2967
|
-
#
|
|
2968
|
-
#
|
|
2969
|
-
#
|
|
2970
|
-
#
|
|
2971
|
-
#
|
|
2972
|
-
# apis:
|
|
2973
|
-
# - name: google.calendar.v3.Calendar
|
|
2974
|
-
# authentication:
|
|
2975
|
-
# providers:
|
|
2976
|
-
# - id: google_calendar_auth
|
|
2977
|
-
# jwks_uri: https://www.googleapis.com/oauth2/v1/certs
|
|
2978
|
-
# issuer: https://securetoken.google.com
|
|
2979
|
-
# rules:
|
|
2980
|
-
# - selector: "*"
|
|
2981
|
-
# requirements:
|
|
2982
|
-
# provider_id: google_calendar_auth
|
|
2536
|
+
# describes basic information about a service, such as the name and the title,
|
|
2537
|
+
# and delegates other aspects to sub-sections. Each sub-section is either a
|
|
2538
|
+
# proto message or a repeated proto message that configures a specific aspect,
|
|
2539
|
+
# such as auth. See each proto message definition for details. Example: type:
|
|
2540
|
+
# google.api.Service config_version: 3 name: calendar.googleapis.com title:
|
|
2541
|
+
# Google Calendar API apis: - name: google.calendar.v3.Calendar authentication:
|
|
2542
|
+
# providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/
|
|
2543
|
+
# oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: "*"
|
|
2544
|
+
# requirements: provider_id: google_calendar_auth
|
|
2983
2545
|
class Service
|
|
2984
2546
|
include Google::Apis::Core::Hashable
|
|
2985
2547
|
|
|
2986
|
-
# A list of API interfaces exported by this service. Only the `name` field
|
|
2987
|
-
#
|
|
2988
|
-
#
|
|
2989
|
-
#
|
|
2990
|
-
#
|
|
2548
|
+
# A list of API interfaces exported by this service. Only the `name` field of
|
|
2549
|
+
# the google.protobuf.Api needs to be provided by the configuration author, as
|
|
2550
|
+
# the remaining fields will be derived from the IDL during the normalization
|
|
2551
|
+
# process. It is an error to specify an API interface here which cannot be
|
|
2552
|
+
# resolved against the associated IDL files.
|
|
2991
2553
|
# Corresponds to the JSON property `apis`
|
|
2992
2554
|
# @return [Array<Google::Apis::ServiceconsumermanagementV1::Api>]
|
|
2993
2555
|
attr_accessor :apis
|
|
2994
2556
|
|
|
2995
|
-
# `Authentication` defines the authentication configuration for an API.
|
|
2996
|
-
#
|
|
2997
|
-
#
|
|
2998
|
-
#
|
|
2999
|
-
#
|
|
3000
|
-
# - id: google_calendar_auth
|
|
3001
|
-
# jwks_uri: https://www.googleapis.com/oauth2/v1/certs
|
|
3002
|
-
# issuer: https://securetoken.google.com
|
|
3003
|
-
# rules:
|
|
3004
|
-
# - selector: "*"
|
|
3005
|
-
# requirements:
|
|
3006
|
-
# provider_id: google_calendar_auth
|
|
2557
|
+
# `Authentication` defines the authentication configuration for an API. Example
|
|
2558
|
+
# for an API targeted for external use: name: calendar.googleapis.com
|
|
2559
|
+
# authentication: providers: - id: google_calendar_auth jwks_uri: https://www.
|
|
2560
|
+
# googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: -
|
|
2561
|
+
# selector: "*" requirements: provider_id: google_calendar_auth
|
|
3007
2562
|
# Corresponds to the JSON property `authentication`
|
|
3008
2563
|
# @return [Google::Apis::ServiceconsumermanagementV1::Authentication]
|
|
3009
2564
|
attr_accessor :authentication
|
|
@@ -3013,211 +2568,136 @@ module Google
|
|
|
3013
2568
|
# @return [Google::Apis::ServiceconsumermanagementV1::Backend]
|
|
3014
2569
|
attr_accessor :backend
|
|
3015
2570
|
|
|
3016
|
-
# Billing related configuration of the service.
|
|
3017
|
-
#
|
|
3018
|
-
#
|
|
3019
|
-
#
|
|
3020
|
-
#
|
|
3021
|
-
#
|
|
3022
|
-
#
|
|
3023
|
-
#
|
|
3024
|
-
# -
|
|
3025
|
-
#
|
|
3026
|
-
# - key:
|
|
3027
|
-
#
|
|
3028
|
-
#
|
|
3029
|
-
# -
|
|
3030
|
-
#
|
|
3031
|
-
# Custom label to define the city where the library branch is located
|
|
3032
|
-
# in.
|
|
3033
|
-
# - key: name
|
|
3034
|
-
# description: Custom label to define the name of the library branch.
|
|
3035
|
-
# metrics:
|
|
3036
|
-
# - name: library.googleapis.com/book/borrowed_count
|
|
3037
|
-
# metric_kind: DELTA
|
|
3038
|
-
# value_type: INT64
|
|
3039
|
-
# unit: "1"
|
|
3040
|
-
# billing:
|
|
3041
|
-
# consumer_destinations:
|
|
3042
|
-
# - monitored_resource: library.googleapis.com/billing_branch
|
|
3043
|
-
# metrics:
|
|
3044
|
-
# - library.googleapis.com/book/borrowed_count
|
|
2571
|
+
# Billing related configuration of the service. The following example shows how
|
|
2572
|
+
# to configure monitored resources and metrics for billing, `
|
|
2573
|
+
# consumer_destinations` is the only supported destination and the monitored
|
|
2574
|
+
# resources need at least one label key `cloud.googleapis.com/location` to
|
|
2575
|
+
# indicate the location of the billing usage, using different monitored
|
|
2576
|
+
# resources between monitoring and billing is recommended so they can be evolved
|
|
2577
|
+
# independently: monitored_resources: - type: library.googleapis.com/
|
|
2578
|
+
# billing_branch labels: - key: cloud.googleapis.com/location description: |
|
|
2579
|
+
# Predefined label to support billing location restriction. - key: city
|
|
2580
|
+
# description: | Custom label to define the city where the library branch is
|
|
2581
|
+
# located in. - key: name description: Custom label to define the name of the
|
|
2582
|
+
# library branch. metrics: - name: library.googleapis.com/book/borrowed_count
|
|
2583
|
+
# metric_kind: DELTA value_type: INT64 unit: "1" billing: consumer_destinations:
|
|
2584
|
+
# - monitored_resource: library.googleapis.com/billing_branch metrics: - library.
|
|
2585
|
+
# googleapis.com/book/borrowed_count
|
|
3045
2586
|
# Corresponds to the JSON property `billing`
|
|
3046
2587
|
# @return [Google::Apis::ServiceconsumermanagementV1::Billing]
|
|
3047
2588
|
attr_accessor :billing
|
|
3048
2589
|
|
|
3049
|
-
# The semantic version of the service configuration. The config version
|
|
3050
|
-
#
|
|
3051
|
-
#
|
|
3052
|
-
#
|
|
2590
|
+
# The semantic version of the service configuration. The config version affects
|
|
2591
|
+
# the interpretation of the service configuration. For example, certain features
|
|
2592
|
+
# are enabled by default for certain config versions. The latest config version
|
|
2593
|
+
# is `3`.
|
|
3053
2594
|
# Corresponds to the JSON property `configVersion`
|
|
3054
2595
|
# @return [Fixnum]
|
|
3055
2596
|
attr_accessor :config_version
|
|
3056
2597
|
|
|
3057
|
-
# `Context` defines which contexts an API requests.
|
|
3058
|
-
#
|
|
3059
|
-
# context
|
|
3060
|
-
#
|
|
3061
|
-
#
|
|
3062
|
-
#
|
|
3063
|
-
# -
|
|
3064
|
-
#
|
|
3065
|
-
#
|
|
3066
|
-
#
|
|
3067
|
-
#
|
|
3068
|
-
#
|
|
3069
|
-
#
|
|
3070
|
-
# This also provides mechanism to whitelist any protobuf message extension that
|
|
3071
|
-
# can be sent in grpc metadata using “x-goog-ext-<extension_id>-bin” and
|
|
3072
|
-
# “x-goog-ext-<extension_id>-jspb” format. For example, list any service
|
|
3073
|
-
# specific protobuf types that can appear in grpc metadata as follows in your
|
|
3074
|
-
# yaml file:
|
|
3075
|
-
# Example:
|
|
3076
|
-
# context:
|
|
3077
|
-
# rules:
|
|
3078
|
-
# - selector: "google.example.library.v1.LibraryService.CreateBook"
|
|
3079
|
-
# allowed_request_extensions:
|
|
3080
|
-
# - google.foo.v1.NewExtension
|
|
3081
|
-
# allowed_response_extensions:
|
|
3082
|
-
# - google.foo.v1.NewExtension
|
|
3083
|
-
# You can also specify extension ID instead of fully qualified extension name
|
|
3084
|
-
# here.
|
|
2598
|
+
# `Context` defines which contexts an API requests. Example: context: rules: -
|
|
2599
|
+
# selector: "*" requested: - google.rpc.context.ProjectContext - google.rpc.
|
|
2600
|
+
# context.OriginContext The above specifies that all methods in the API request `
|
|
2601
|
+
# google.rpc.context.ProjectContext` and `google.rpc.context.OriginContext`.
|
|
2602
|
+
# Available context types are defined in package `google.rpc.context`. This also
|
|
2603
|
+
# provides mechanism to whitelist any protobuf message extension that can be
|
|
2604
|
+
# sent in grpc metadata using “x-goog-ext--bin” and “x-goog-ext--jspb” format.
|
|
2605
|
+
# For example, list any service specific protobuf types that can appear in grpc
|
|
2606
|
+
# metadata as follows in your yaml file: Example: context: rules: - selector: "
|
|
2607
|
+
# google.example.library.v1.LibraryService.CreateBook"
|
|
2608
|
+
# allowed_request_extensions: - google.foo.v1.NewExtension
|
|
2609
|
+
# allowed_response_extensions: - google.foo.v1.NewExtension You can also specify
|
|
2610
|
+
# extension ID instead of fully qualified extension name here.
|
|
3085
2611
|
# Corresponds to the JSON property `context`
|
|
3086
2612
|
# @return [Google::Apis::ServiceconsumermanagementV1::Context]
|
|
3087
2613
|
attr_accessor :context
|
|
3088
2614
|
|
|
3089
|
-
# Selects and configures the service controller used by the service.
|
|
3090
|
-
#
|
|
3091
|
-
#
|
|
2615
|
+
# Selects and configures the service controller used by the service. The service
|
|
2616
|
+
# controller handles features like abuse, quota, billing, logging, monitoring,
|
|
2617
|
+
# etc.
|
|
3092
2618
|
# Corresponds to the JSON property `control`
|
|
3093
2619
|
# @return [Google::Apis::ServiceconsumermanagementV1::Control]
|
|
3094
2620
|
attr_accessor :control
|
|
3095
2621
|
|
|
3096
|
-
# Customize service error responses.
|
|
3097
|
-
#
|
|
3098
|
-
#
|
|
3099
|
-
#
|
|
3100
|
-
# custom_error:
|
|
3101
|
-
# types:
|
|
3102
|
-
# - google.foo.v1.CustomError
|
|
3103
|
-
# - google.foo.v1.AnotherError
|
|
2622
|
+
# Customize service error responses. For example, list any service specific
|
|
2623
|
+
# protobuf types that can appear in error detail lists of error responses.
|
|
2624
|
+
# Example: custom_error: types: - google.foo.v1.CustomError - google.foo.v1.
|
|
2625
|
+
# AnotherError
|
|
3104
2626
|
# Corresponds to the JSON property `customError`
|
|
3105
2627
|
# @return [Google::Apis::ServiceconsumermanagementV1::CustomError]
|
|
3106
2628
|
attr_accessor :custom_error
|
|
3107
2629
|
|
|
3108
|
-
# `Documentation` provides the information for describing a service.
|
|
3109
|
-
#
|
|
3110
|
-
#
|
|
3111
|
-
#
|
|
3112
|
-
#
|
|
3113
|
-
#
|
|
3114
|
-
#
|
|
3115
|
-
#
|
|
3116
|
-
#
|
|
3117
|
-
#
|
|
3118
|
-
#
|
|
3119
|
-
#
|
|
3120
|
-
#
|
|
3121
|
-
#
|
|
3122
|
-
#
|
|
3123
|
-
#
|
|
3124
|
-
#
|
|
3125
|
-
#
|
|
3126
|
-
#
|
|
3127
|
-
#
|
|
3128
|
-
#
|
|
3129
|
-
#
|
|
3130
|
-
#
|
|
3131
|
-
#
|
|
3132
|
-
#
|
|
3133
|
-
#
|
|
3134
|
-
# a documentation fragment is embedded.
|
|
3135
|
-
# Documentation from the IDL is merged with documentation defined
|
|
3136
|
-
# via the config at normalization time, where documentation provided
|
|
3137
|
-
# by config rules overrides IDL provided.
|
|
3138
|
-
# A number of constructs specific to the API platform are supported
|
|
3139
|
-
# in documentation text.
|
|
3140
|
-
# In order to reference a proto element, the following
|
|
3141
|
-
# notation can be used:
|
|
3142
|
-
# <pre><code>[fully.qualified.proto.name][]</code></pre>
|
|
3143
|
-
# To override the display text used for the link, this can be used:
|
|
3144
|
-
# <pre><code>[display text][fully.qualified.proto.name]</code></pre>
|
|
3145
|
-
# Text can be excluded from doc using the following notation:
|
|
3146
|
-
# <pre><code>(-- internal comment --)</code></pre>
|
|
3147
|
-
# A few directives are available in documentation. Note that
|
|
3148
|
-
# directives must appear on a single line to be properly
|
|
3149
|
-
# identified. The `include` directive includes a markdown file from
|
|
3150
|
-
# an external source:
|
|
3151
|
-
# <pre><code>(== include path/to/file ==)</code></pre>
|
|
3152
|
-
# The `resource_for` directive marks a message to be the resource of
|
|
3153
|
-
# a collection in REST view. If it is not specified, tools attempt
|
|
3154
|
-
# to infer the resource from the operations in a collection:
|
|
3155
|
-
# <pre><code>(== resource_for v1.shelves.books ==)</code></pre>
|
|
3156
|
-
# The directive `suppress_warning` does not directly affect documentation
|
|
3157
|
-
# and is documented together with service config validation.
|
|
2630
|
+
# `Documentation` provides the information for describing a service. Example:
|
|
2631
|
+
# documentation: summary: > The Google Calendar API gives access to most
|
|
2632
|
+
# calendar features. pages: - name: Overview content: (== include google/foo/
|
|
2633
|
+
# overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==
|
|
2634
|
+
# ) subpages; - name: Java content: (== include google/foo/tutorial_java.md ==)
|
|
2635
|
+
# rules: - selector: google.calendar.Calendar.Get description: > ... - selector:
|
|
2636
|
+
# google.calendar.Calendar.Put description: > ... Documentation is provided in
|
|
2637
|
+
# markdown syntax. In addition to standard markdown features, definition lists,
|
|
2638
|
+
# tables and fenced code blocks are supported. Section headers can be provided
|
|
2639
|
+
# and are interpreted relative to the section nesting of the context where a
|
|
2640
|
+
# documentation fragment is embedded. Documentation from the IDL is merged with
|
|
2641
|
+
# documentation defined via the config at normalization time, where
|
|
2642
|
+
# documentation provided by config rules overrides IDL provided. A number of
|
|
2643
|
+
# constructs specific to the API platform are supported in documentation text.
|
|
2644
|
+
# In order to reference a proto element, the following notation can be used: [
|
|
2645
|
+
# fully.qualified.proto.name][] To override the display text used for the link,
|
|
2646
|
+
# this can be used: [display text][fully.qualified.proto.name] Text can be
|
|
2647
|
+
# excluded from doc using the following notation: (-- internal comment --) A few
|
|
2648
|
+
# directives are available in documentation. Note that directives must appear on
|
|
2649
|
+
# a single line to be properly identified. The `include` directive includes a
|
|
2650
|
+
# markdown file from an external source: (== include path/to/file ==) The `
|
|
2651
|
+
# resource_for` directive marks a message to be the resource of a collection in
|
|
2652
|
+
# REST view. If it is not specified, tools attempt to infer the resource from
|
|
2653
|
+
# the operations in a collection: (== resource_for v1.shelves.books ==) The
|
|
2654
|
+
# directive `suppress_warning` does not directly affect documentation and is
|
|
2655
|
+
# documented together with service config validation.
|
|
3158
2656
|
# Corresponds to the JSON property `documentation`
|
|
3159
2657
|
# @return [Google::Apis::ServiceconsumermanagementV1::Documentation]
|
|
3160
2658
|
attr_accessor :documentation
|
|
3161
2659
|
|
|
3162
|
-
# Configuration for network endpoints.
|
|
3163
|
-
#
|
|
3164
|
-
#
|
|
2660
|
+
# Configuration for network endpoints. If this is empty, then an endpoint with
|
|
2661
|
+
# the same name as the service is automatically generated to service all defined
|
|
2662
|
+
# APIs.
|
|
3165
2663
|
# Corresponds to the JSON property `endpoints`
|
|
3166
2664
|
# @return [Array<Google::Apis::ServiceconsumermanagementV1::Endpoint>]
|
|
3167
2665
|
attr_accessor :endpoints
|
|
3168
2666
|
|
|
3169
|
-
# A list of all enum types included in this API service.
|
|
3170
|
-
#
|
|
3171
|
-
#
|
|
3172
|
-
#
|
|
3173
|
-
# enums:
|
|
3174
|
-
# - name: google.someapi.v1.SomeEnum
|
|
2667
|
+
# A list of all enum types included in this API service. Enums referenced
|
|
2668
|
+
# directly or indirectly by the `apis` are automatically included. Enums which
|
|
2669
|
+
# are not referenced but shall be included should be listed here by name.
|
|
2670
|
+
# Example: enums: - name: google.someapi.v1.SomeEnum
|
|
3175
2671
|
# Corresponds to the JSON property `enums`
|
|
3176
2672
|
# @return [Array<Google::Apis::ServiceconsumermanagementV1::Enum>]
|
|
3177
2673
|
attr_accessor :enums
|
|
3178
2674
|
|
|
3179
2675
|
# Defines the HTTP configuration for an API service. It contains a list of
|
|
3180
|
-
# HttpRule, each specifying the mapping of an RPC method
|
|
3181
|
-
#
|
|
2676
|
+
# HttpRule, each specifying the mapping of an RPC method to one or more HTTP
|
|
2677
|
+
# REST API methods.
|
|
3182
2678
|
# Corresponds to the JSON property `http`
|
|
3183
2679
|
# @return [Google::Apis::ServiceconsumermanagementV1::Http]
|
|
3184
2680
|
attr_accessor :http
|
|
3185
2681
|
|
|
3186
|
-
# A unique ID for a specific instance of this message, typically assigned
|
|
3187
|
-
#
|
|
3188
|
-
#
|
|
3189
|
-
#
|
|
2682
|
+
# A unique ID for a specific instance of this message, typically assigned by the
|
|
2683
|
+
# client for tracking purpose. Must be no longer than 63 characters and only
|
|
2684
|
+
# lower case letters, digits, '.', '_' and '-' are allowed. If empty, the server
|
|
2685
|
+
# may choose to generate one instead.
|
|
3190
2686
|
# Corresponds to the JSON property `id`
|
|
3191
2687
|
# @return [String]
|
|
3192
2688
|
attr_accessor :id
|
|
3193
2689
|
|
|
3194
|
-
# Logging configuration of the service.
|
|
3195
|
-
#
|
|
3196
|
-
#
|
|
3197
|
-
# log is sent to
|
|
3198
|
-
#
|
|
3199
|
-
#
|
|
3200
|
-
# -
|
|
3201
|
-
# labels:
|
|
3202
|
-
# -
|
|
3203
|
-
#
|
|
3204
|
-
#
|
|
3205
|
-
# description: The name of the branch.
|
|
3206
|
-
# logs:
|
|
3207
|
-
# - name: activity_history
|
|
3208
|
-
# labels:
|
|
3209
|
-
# - key: /customer_id
|
|
3210
|
-
# - name: purchase_history
|
|
3211
|
-
# logging:
|
|
3212
|
-
# producer_destinations:
|
|
3213
|
-
# - monitored_resource: library.googleapis.com/branch
|
|
3214
|
-
# logs:
|
|
3215
|
-
# - activity_history
|
|
3216
|
-
# - purchase_history
|
|
3217
|
-
# consumer_destinations:
|
|
3218
|
-
# - monitored_resource: library.googleapis.com/branch
|
|
3219
|
-
# logs:
|
|
3220
|
-
# - activity_history
|
|
2690
|
+
# Logging configuration of the service. The following example shows how to
|
|
2691
|
+
# configure logs to be sent to the producer and consumer projects. In the
|
|
2692
|
+
# example, the `activity_history` log is sent to both the producer and consumer
|
|
2693
|
+
# projects, whereas the `purchase_history` log is only sent to the producer
|
|
2694
|
+
# project. monitored_resources: - type: library.googleapis.com/branch labels: -
|
|
2695
|
+
# key: /city description: The city where the library branch is located in. - key:
|
|
2696
|
+
# /name description: The name of the branch. logs: - name: activity_history
|
|
2697
|
+
# labels: - key: /customer_id - name: purchase_history logging:
|
|
2698
|
+
# producer_destinations: - monitored_resource: library.googleapis.com/branch
|
|
2699
|
+
# logs: - activity_history - purchase_history consumer_destinations: -
|
|
2700
|
+
# monitored_resource: library.googleapis.com/branch logs: - activity_history
|
|
3221
2701
|
# Corresponds to the JSON property `logging`
|
|
3222
2702
|
# @return [Google::Apis::ServiceconsumermanagementV1::Logging]
|
|
3223
2703
|
attr_accessor :logging
|
|
@@ -3232,70 +2712,41 @@ module Google
|
|
|
3232
2712
|
# @return [Array<Google::Apis::ServiceconsumermanagementV1::MetricDescriptor>]
|
|
3233
2713
|
attr_accessor :metrics
|
|
3234
2714
|
|
|
3235
|
-
# Defines the monitored resources used by this service. This is required
|
|
3236
|
-
#
|
|
2715
|
+
# Defines the monitored resources used by this service. This is required by the
|
|
2716
|
+
# Service.monitoring and Service.logging configurations.
|
|
3237
2717
|
# Corresponds to the JSON property `monitoredResources`
|
|
3238
2718
|
# @return [Array<Google::Apis::ServiceconsumermanagementV1::MonitoredResourceDescriptor>]
|
|
3239
2719
|
attr_accessor :monitored_resources
|
|
3240
2720
|
|
|
3241
|
-
# Monitoring configuration of the service.
|
|
3242
|
-
#
|
|
3243
|
-
#
|
|
3244
|
-
#
|
|
3245
|
-
#
|
|
3246
|
-
#
|
|
3247
|
-
#
|
|
3248
|
-
#
|
|
3249
|
-
# -
|
|
3250
|
-
#
|
|
3251
|
-
#
|
|
3252
|
-
#
|
|
3253
|
-
#
|
|
3254
|
-
# - key:
|
|
3255
|
-
#
|
|
3256
|
-
#
|
|
3257
|
-
#
|
|
3258
|
-
#
|
|
3259
|
-
#
|
|
3260
|
-
#
|
|
3261
|
-
#
|
|
3262
|
-
#
|
|
3263
|
-
# description: "The count of books that have been returned."
|
|
3264
|
-
# launch_stage: GA
|
|
3265
|
-
# metric_kind: DELTA
|
|
3266
|
-
# value_type: INT64
|
|
3267
|
-
# unit: "1"
|
|
3268
|
-
# labels:
|
|
3269
|
-
# - key: customer_id
|
|
3270
|
-
# description: "The id of the customer."
|
|
3271
|
-
# - name: library.googleapis.com/book/num_overdue
|
|
3272
|
-
# display_name: "Books Overdue"
|
|
3273
|
-
# description: "The current number of overdue books."
|
|
3274
|
-
# launch_stage: GA
|
|
3275
|
-
# metric_kind: GAUGE
|
|
3276
|
-
# value_type: INT64
|
|
3277
|
-
# unit: "1"
|
|
3278
|
-
# labels:
|
|
3279
|
-
# - key: customer_id
|
|
3280
|
-
# description: "The id of the customer."
|
|
3281
|
-
# monitoring:
|
|
3282
|
-
# producer_destinations:
|
|
3283
|
-
# - monitored_resource: library.googleapis.com/Branch
|
|
3284
|
-
# metrics:
|
|
3285
|
-
# - library.googleapis.com/book/returned_count
|
|
3286
|
-
# consumer_destinations:
|
|
3287
|
-
# - monitored_resource: library.googleapis.com/Branch
|
|
3288
|
-
# metrics:
|
|
3289
|
-
# - library.googleapis.com/book/returned_count
|
|
3290
|
-
# - library.googleapis.com/book/num_overdue
|
|
2721
|
+
# Monitoring configuration of the service. The example below shows how to
|
|
2722
|
+
# configure monitored resources and metrics for monitoring. In the example, a
|
|
2723
|
+
# monitored resource and two metrics are defined. The `library.googleapis.com/
|
|
2724
|
+
# book/returned_count` metric is sent to both producer and consumer projects,
|
|
2725
|
+
# whereas the `library.googleapis.com/book/num_overdue` metric is only sent to
|
|
2726
|
+
# the consumer project. monitored_resources: - type: library.googleapis.com/
|
|
2727
|
+
# Branch display_name: "Library Branch" description: "A branch of a library."
|
|
2728
|
+
# launch_stage: GA labels: - key: resource_container description: "The Cloud
|
|
2729
|
+
# container (ie. project id) for the Branch." - key: location description: "The
|
|
2730
|
+
# location of the library branch." - key: branch_id description: "The id of the
|
|
2731
|
+
# branch." metrics: - name: library.googleapis.com/book/returned_count
|
|
2732
|
+
# display_name: "Books Returned" description: "The count of books that have been
|
|
2733
|
+
# returned." launch_stage: GA metric_kind: DELTA value_type: INT64 unit: "1"
|
|
2734
|
+
# labels: - key: customer_id description: "The id of the customer." - name:
|
|
2735
|
+
# library.googleapis.com/book/num_overdue display_name: "Books Overdue"
|
|
2736
|
+
# description: "The current number of overdue books." launch_stage: GA
|
|
2737
|
+
# metric_kind: GAUGE value_type: INT64 unit: "1" labels: - key: customer_id
|
|
2738
|
+
# description: "The id of the customer." monitoring: producer_destinations: -
|
|
2739
|
+
# monitored_resource: library.googleapis.com/Branch metrics: - library.
|
|
2740
|
+
# googleapis.com/book/returned_count consumer_destinations: - monitored_resource:
|
|
2741
|
+
# library.googleapis.com/Branch metrics: - library.googleapis.com/book/
|
|
2742
|
+
# returned_count - library.googleapis.com/book/num_overdue
|
|
3291
2743
|
# Corresponds to the JSON property `monitoring`
|
|
3292
2744
|
# @return [Google::Apis::ServiceconsumermanagementV1::Monitoring]
|
|
3293
2745
|
attr_accessor :monitoring
|
|
3294
2746
|
|
|
3295
|
-
# The service name, which is a DNS-like logical identifier for the
|
|
3296
|
-
#
|
|
3297
|
-
#
|
|
3298
|
-
# of the service also owns the DNS name.
|
|
2747
|
+
# The service name, which is a DNS-like logical identifier for the service, such
|
|
2748
|
+
# as `calendar.googleapis.com`. The service name typically goes through DNS
|
|
2749
|
+
# verification to make sure the owner of the service also owns the DNS name.
|
|
3299
2750
|
# Corresponds to the JSON property `name`
|
|
3300
2751
|
# @return [String]
|
|
3301
2752
|
attr_accessor :name
|
|
@@ -3305,46 +2756,25 @@ module Google
|
|
|
3305
2756
|
# @return [String]
|
|
3306
2757
|
attr_accessor :producer_project_id
|
|
3307
2758
|
|
|
3308
|
-
# Quota configuration helps to achieve fairness and budgeting in service
|
|
3309
|
-
#
|
|
3310
|
-
#
|
|
3311
|
-
#
|
|
3312
|
-
#
|
|
3313
|
-
#
|
|
3314
|
-
#
|
|
3315
|
-
#
|
|
3316
|
-
#
|
|
3317
|
-
#
|
|
3318
|
-
#
|
|
3319
|
-
# -
|
|
3320
|
-
#
|
|
3321
|
-
#
|
|
3322
|
-
#
|
|
3323
|
-
#
|
|
3324
|
-
#
|
|
3325
|
-
#
|
|
3326
|
-
#
|
|
3327
|
-
# # consuming at twice rate as the DeleteBook method.
|
|
3328
|
-
# metric_rules:
|
|
3329
|
-
# - selector: "*"
|
|
3330
|
-
# metric_costs:
|
|
3331
|
-
# library.googleapis.com/read_calls: 1
|
|
3332
|
-
# - selector: google.example.library.v1.LibraryService.UpdateBook
|
|
3333
|
-
# metric_costs:
|
|
3334
|
-
# library.googleapis.com/write_calls: 2
|
|
3335
|
-
# - selector: google.example.library.v1.LibraryService.DeleteBook
|
|
3336
|
-
# metric_costs:
|
|
3337
|
-
# library.googleapis.com/write_calls: 1
|
|
3338
|
-
# Corresponding Metric definition:
|
|
3339
|
-
# metrics:
|
|
3340
|
-
# - name: library.googleapis.com/read_calls
|
|
3341
|
-
# display_name: Read requests
|
|
3342
|
-
# metric_kind: DELTA
|
|
3343
|
-
# value_type: INT64
|
|
3344
|
-
# - name: library.googleapis.com/write_calls
|
|
3345
|
-
# display_name: Write requests
|
|
3346
|
-
# metric_kind: DELTA
|
|
3347
|
-
# value_type: INT64
|
|
2759
|
+
# Quota configuration helps to achieve fairness and budgeting in service usage.
|
|
2760
|
+
# The metric based quota configuration works this way: - The service
|
|
2761
|
+
# configuration defines a set of metrics. - For API calls, the quota.
|
|
2762
|
+
# metric_rules maps methods to metrics with corresponding costs. - The quota.
|
|
2763
|
+
# limits defines limits on the metrics, which will be used for quota checks at
|
|
2764
|
+
# runtime. An example quota configuration in yaml format: quota: limits: - name:
|
|
2765
|
+
# apiWriteQpsPerProject metric: library.googleapis.com/write_calls unit: "1/min/`
|
|
2766
|
+
# project`" # rate limit for consumer projects values: STANDARD: 10000 # The
|
|
2767
|
+
# metric rules bind all methods to the read_calls metric, # except for the
|
|
2768
|
+
# UpdateBook and DeleteBook methods. These two methods # are mapped to the
|
|
2769
|
+
# write_calls metric, with the UpdateBook method # consuming at twice rate as
|
|
2770
|
+
# the DeleteBook method. metric_rules: - selector: "*" metric_costs: library.
|
|
2771
|
+
# googleapis.com/read_calls: 1 - selector: google.example.library.v1.
|
|
2772
|
+
# LibraryService.UpdateBook metric_costs: library.googleapis.com/write_calls: 2 -
|
|
2773
|
+
# selector: google.example.library.v1.LibraryService.DeleteBook metric_costs:
|
|
2774
|
+
# library.googleapis.com/write_calls: 1 Corresponding Metric definition: metrics:
|
|
2775
|
+
# - name: library.googleapis.com/read_calls display_name: Read requests
|
|
2776
|
+
# metric_kind: DELTA value_type: INT64 - name: library.googleapis.com/
|
|
2777
|
+
# write_calls display_name: Write requests metric_kind: DELTA value_type: INT64
|
|
3348
2778
|
# Corresponds to the JSON property `quota`
|
|
3349
2779
|
# @return [Google::Apis::ServiceconsumermanagementV1::Quota]
|
|
3350
2780
|
attr_accessor :quota
|
|
@@ -3354,20 +2784,18 @@ module Google
|
|
|
3354
2784
|
# @return [Google::Apis::ServiceconsumermanagementV1::SourceInfo]
|
|
3355
2785
|
attr_accessor :source_info
|
|
3356
2786
|
|
|
3357
|
-
# ### System parameter configuration
|
|
3358
|
-
#
|
|
3359
|
-
#
|
|
3360
|
-
#
|
|
3361
|
-
# change the names of the system parameters.
|
|
2787
|
+
# ### System parameter configuration A system parameter is a special kind of
|
|
2788
|
+
# parameter defined by the API system, not by an individual API. It is typically
|
|
2789
|
+
# mapped to an HTTP header and/or a URL query parameter. This configuration
|
|
2790
|
+
# specifies which methods change the names of the system parameters.
|
|
3362
2791
|
# Corresponds to the JSON property `systemParameters`
|
|
3363
2792
|
# @return [Google::Apis::ServiceconsumermanagementV1::SystemParameters]
|
|
3364
2793
|
attr_accessor :system_parameters
|
|
3365
2794
|
|
|
3366
|
-
# A list of all proto message types included in this API service.
|
|
3367
|
-
#
|
|
3368
|
-
#
|
|
3369
|
-
#
|
|
3370
|
-
# to define system APIs in ESF.
|
|
2795
|
+
# A list of all proto message types included in this API service. It serves
|
|
2796
|
+
# similar purpose as [google.api.Service.types], except that these types are not
|
|
2797
|
+
# needed by user-defined APIs. Therefore, they will not show up in the generated
|
|
2798
|
+
# discovery doc. This field should only be used to define system APIs in ESF.
|
|
3371
2799
|
# Corresponds to the JSON property `systemTypes`
|
|
3372
2800
|
# @return [Array<Google::Apis::ServiceconsumermanagementV1::Type>]
|
|
3373
2801
|
attr_accessor :system_types
|
|
@@ -3377,12 +2805,10 @@ module Google
|
|
|
3377
2805
|
# @return [String]
|
|
3378
2806
|
attr_accessor :title
|
|
3379
2807
|
|
|
3380
|
-
# A list of all proto message types included in this API service.
|
|
3381
|
-
#
|
|
3382
|
-
#
|
|
3383
|
-
#
|
|
3384
|
-
# should be listed here by name. Example:
|
|
3385
|
-
# types:
|
|
2808
|
+
# A list of all proto message types included in this API service. Types
|
|
2809
|
+
# referenced directly or indirectly by the `apis` are automatically included.
|
|
2810
|
+
# Messages which are not referenced but shall be included, such as types used by
|
|
2811
|
+
# the `google.protobuf.Any` type, should be listed here by name. Example: types:
|
|
3386
2812
|
# - name: google.protobuf.Int32
|
|
3387
2813
|
# Corresponds to the JSON property `types`
|
|
3388
2814
|
# @return [Array<Google::Apis::ServiceconsumermanagementV1::Type>]
|
|
@@ -3433,12 +2859,11 @@ module Google
|
|
|
3433
2859
|
class ServiceAccountConfig
|
|
3434
2860
|
include Google::Apis::Core::Hashable
|
|
3435
2861
|
|
|
3436
|
-
# ID of the IAM service account to be created in tenant project.
|
|
3437
|
-
#
|
|
3438
|
-
#
|
|
3439
|
-
#
|
|
3440
|
-
#
|
|
3441
|
-
# match the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])`.
|
|
2862
|
+
# ID of the IAM service account to be created in tenant project. The email
|
|
2863
|
+
# format of the service account is "@.iam.gserviceaccount.com". This account ID
|
|
2864
|
+
# must be unique within tenant project and service producers have to guarantee
|
|
2865
|
+
# it. The ID must be 6-30 characters long, and match the following regular
|
|
2866
|
+
# expression: `[a-z]([-a-z0-9]*[a-z0-9])`.
|
|
3442
2867
|
# Corresponds to the JSON property `accountId`
|
|
3443
2868
|
# @return [String]
|
|
3444
2869
|
attr_accessor :account_id
|
|
@@ -3459,32 +2884,28 @@ module Google
|
|
|
3459
2884
|
end
|
|
3460
2885
|
end
|
|
3461
2886
|
|
|
3462
|
-
# The per-product per-project service identity for a service.
|
|
3463
|
-
#
|
|
3464
|
-
#
|
|
3465
|
-
#
|
|
3466
|
-
#
|
|
3467
|
-
# - service_account_parent: "projects/123456789"
|
|
3468
|
-
# display_name: "Cloud XXX Service Agent"
|
|
3469
|
-
# description: "Used as the identity of Cloud XXX to access resources"
|
|
2887
|
+
# The per-product per-project service identity for a service. Use this field to
|
|
2888
|
+
# configure per-product per-project service identity. Example of a service
|
|
2889
|
+
# identity configuration. usage: service_identity: - service_account_parent: "
|
|
2890
|
+
# projects/123456789" display_name: "Cloud XXX Service Agent" description: "Used
|
|
2891
|
+
# as the identity of Cloud XXX to access resources"
|
|
3470
2892
|
class ServiceIdentity
|
|
3471
2893
|
include Google::Apis::Core::Hashable
|
|
3472
2894
|
|
|
3473
|
-
# Optional. A user-specified opaque description of the service account.
|
|
3474
|
-
#
|
|
2895
|
+
# Optional. A user-specified opaque description of the service account. Must be
|
|
2896
|
+
# less than or equal to 256 UTF-8 bytes.
|
|
3475
2897
|
# Corresponds to the JSON property `description`
|
|
3476
2898
|
# @return [String]
|
|
3477
2899
|
attr_accessor :description
|
|
3478
2900
|
|
|
3479
|
-
# Optional. A user-specified name for the service account.
|
|
3480
|
-
#
|
|
2901
|
+
# Optional. A user-specified name for the service account. Must be less than or
|
|
2902
|
+
# equal to 100 UTF-8 bytes.
|
|
3481
2903
|
# Corresponds to the JSON property `displayName`
|
|
3482
2904
|
# @return [String]
|
|
3483
2905
|
attr_accessor :display_name
|
|
3484
2906
|
|
|
3485
|
-
# A service account project that hosts the service accounts.
|
|
3486
|
-
#
|
|
3487
|
-
# `projects/123456789`
|
|
2907
|
+
# A service account project that hosts the service accounts. An example name
|
|
2908
|
+
# would be: `projects/123456789`
|
|
3488
2909
|
# Corresponds to the JSON property `serviceAccountParent`
|
|
3489
2910
|
# @return [String]
|
|
3490
2911
|
attr_accessor :service_account_parent
|
|
@@ -3501,13 +2922,13 @@ module Google
|
|
|
3501
2922
|
end
|
|
3502
2923
|
end
|
|
3503
2924
|
|
|
3504
|
-
# `SourceContext` represents information about the source of a
|
|
3505
|
-
#
|
|
2925
|
+
# `SourceContext` represents information about the source of a protobuf element,
|
|
2926
|
+
# like the file in which it is defined.
|
|
3506
2927
|
class SourceContext
|
|
3507
2928
|
include Google::Apis::Core::Hashable
|
|
3508
2929
|
|
|
3509
2930
|
# The path-qualified name of the .proto file that contained the associated
|
|
3510
|
-
# protobuf element.
|
|
2931
|
+
# protobuf element. For example: `"google/protobuf/source_context.proto"`.
|
|
3511
2932
|
# Corresponds to the JSON property `fileName`
|
|
3512
2933
|
# @return [String]
|
|
3513
2934
|
attr_accessor :file_name
|
|
@@ -3541,12 +2962,12 @@ module Google
|
|
|
3541
2962
|
end
|
|
3542
2963
|
end
|
|
3543
2964
|
|
|
3544
|
-
# The `Status` type defines a logical error model that is suitable for
|
|
3545
|
-
#
|
|
3546
|
-
#
|
|
3547
|
-
#
|
|
3548
|
-
#
|
|
3549
|
-
#
|
|
2965
|
+
# The `Status` type defines a logical error model that is suitable for different
|
|
2966
|
+
# programming environments, including REST APIs and RPC APIs. It is used by [
|
|
2967
|
+
# gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
|
|
2968
|
+
# data: error code, error message, and error details. You can find out more
|
|
2969
|
+
# about this error model and how to work with it in the [API Design Guide](https:
|
|
2970
|
+
# //cloud.google.com/apis/design/errors).
|
|
3550
2971
|
class Status
|
|
3551
2972
|
include Google::Apis::Core::Hashable
|
|
3552
2973
|
|
|
@@ -3555,15 +2976,15 @@ module Google
|
|
|
3555
2976
|
# @return [Fixnum]
|
|
3556
2977
|
attr_accessor :code
|
|
3557
2978
|
|
|
3558
|
-
# A list of messages that carry the error details.
|
|
2979
|
+
# A list of messages that carry the error details. There is a common set of
|
|
3559
2980
|
# message types for APIs to use.
|
|
3560
2981
|
# Corresponds to the JSON property `details`
|
|
3561
2982
|
# @return [Array<Hash<String,Object>>]
|
|
3562
2983
|
attr_accessor :details
|
|
3563
2984
|
|
|
3564
|
-
# A developer-facing error message, which should be in English. Any
|
|
3565
|
-
#
|
|
3566
|
-
#
|
|
2985
|
+
# A developer-facing error message, which should be in English. Any user-facing
|
|
2986
|
+
# error message should be localized and sent in the google.rpc.Status.details
|
|
2987
|
+
# field, or localized by the client.
|
|
3567
2988
|
# Corresponds to the JSON property `message`
|
|
3568
2989
|
# @return [String]
|
|
3569
2990
|
attr_accessor :message
|
|
@@ -3586,8 +3007,7 @@ module Google
|
|
|
3586
3007
|
class SystemParameter
|
|
3587
3008
|
include Google::Apis::Core::Hashable
|
|
3588
3009
|
|
|
3589
|
-
# Define the HTTP header name to use for the parameter. It is case
|
|
3590
|
-
# insensitive.
|
|
3010
|
+
# Define the HTTP header name to use for the parameter. It is case insensitive.
|
|
3591
3011
|
# Corresponds to the JSON property `httpHeader`
|
|
3592
3012
|
# @return [String]
|
|
3593
3013
|
attr_accessor :http_header
|
|
@@ -3615,23 +3035,20 @@ module Google
|
|
|
3615
3035
|
end
|
|
3616
3036
|
end
|
|
3617
3037
|
|
|
3618
|
-
# Define a system parameter rule mapping system parameter definitions to
|
|
3619
|
-
# methods.
|
|
3038
|
+
# Define a system parameter rule mapping system parameter definitions to methods.
|
|
3620
3039
|
class SystemParameterRule
|
|
3621
3040
|
include Google::Apis::Core::Hashable
|
|
3622
3041
|
|
|
3623
|
-
# Define parameters. Multiple names may be defined for a parameter.
|
|
3624
|
-
#
|
|
3625
|
-
#
|
|
3626
|
-
#
|
|
3627
|
-
# parameter-dependent.
|
|
3042
|
+
# Define parameters. Multiple names may be defined for a parameter. For a given
|
|
3043
|
+
# method call, only one of them should be used. If multiple names are used the
|
|
3044
|
+
# behavior is implementation-dependent. If none of the specified names are
|
|
3045
|
+
# present the behavior is parameter-dependent.
|
|
3628
3046
|
# Corresponds to the JSON property `parameters`
|
|
3629
3047
|
# @return [Array<Google::Apis::ServiceconsumermanagementV1::SystemParameter>]
|
|
3630
3048
|
attr_accessor :parameters
|
|
3631
3049
|
|
|
3632
3050
|
# Selects the methods to which this rule applies. Use '*' to indicate all
|
|
3633
|
-
# methods in all APIs.
|
|
3634
|
-
# Refer to selector for syntax details.
|
|
3051
|
+
# methods in all APIs. Refer to selector for syntax details.
|
|
3635
3052
|
# Corresponds to the JSON property `selector`
|
|
3636
3053
|
# @return [String]
|
|
3637
3054
|
attr_accessor :selector
|
|
@@ -3647,36 +3064,23 @@ module Google
|
|
|
3647
3064
|
end
|
|
3648
3065
|
end
|
|
3649
3066
|
|
|
3650
|
-
# ### System parameter configuration
|
|
3651
|
-
#
|
|
3652
|
-
#
|
|
3653
|
-
#
|
|
3654
|
-
# change the names of the system parameters.
|
|
3067
|
+
# ### System parameter configuration A system parameter is a special kind of
|
|
3068
|
+
# parameter defined by the API system, not by an individual API. It is typically
|
|
3069
|
+
# mapped to an HTTP header and/or a URL query parameter. This configuration
|
|
3070
|
+
# specifies which methods change the names of the system parameters.
|
|
3655
3071
|
class SystemParameters
|
|
3656
3072
|
include Google::Apis::Core::Hashable
|
|
3657
3073
|
|
|
3658
|
-
# Define system parameters.
|
|
3659
|
-
#
|
|
3660
|
-
#
|
|
3661
|
-
#
|
|
3662
|
-
#
|
|
3663
|
-
# Example: define api key for
|
|
3664
|
-
# system_parameters
|
|
3665
|
-
#
|
|
3666
|
-
# -
|
|
3667
|
-
#
|
|
3668
|
-
# - name: api_key
|
|
3669
|
-
# url_query_parameter: api_key
|
|
3670
|
-
# Example: define 2 api key names for a specific method.
|
|
3671
|
-
# system_parameters
|
|
3672
|
-
# rules:
|
|
3673
|
-
# - selector: "/ListShelves"
|
|
3674
|
-
# parameters:
|
|
3675
|
-
# - name: api_key
|
|
3676
|
-
# http_header: Api-Key1
|
|
3677
|
-
# - name: api_key
|
|
3678
|
-
# http_header: Api-Key2
|
|
3679
|
-
# **NOTE:** All service configuration rules follow "last one wins" order.
|
|
3074
|
+
# Define system parameters. The parameters defined here will override the
|
|
3075
|
+
# default parameters implemented by the system. If this field is missing from
|
|
3076
|
+
# the service config, default system parameters will be used. Default system
|
|
3077
|
+
# parameters and names is implementation-dependent. Example: define api key for
|
|
3078
|
+
# all methods system_parameters rules: - selector: "*" parameters: - name:
|
|
3079
|
+
# api_key url_query_parameter: api_key Example: define 2 api key names for a
|
|
3080
|
+
# specific method. system_parameters rules: - selector: "/ListShelves"
|
|
3081
|
+
# parameters: - name: api_key http_header: Api-Key1 - name: api_key http_header:
|
|
3082
|
+
# Api-Key2 **NOTE:** All service configuration rules follow "last one wins"
|
|
3083
|
+
# order.
|
|
3680
3084
|
# Corresponds to the JSON property `rules`
|
|
3681
3085
|
# @return [Array<Google::Apis::ServiceconsumermanagementV1::SystemParameterRule>]
|
|
3682
3086
|
attr_accessor :rules
|
|
@@ -3695,8 +3099,8 @@ module Google
|
|
|
3695
3099
|
class TenancyUnit
|
|
3696
3100
|
include Google::Apis::Core::Hashable
|
|
3697
3101
|
|
|
3698
|
-
# @OutputOnly Cloud resource name of the consumer of this service.
|
|
3699
|
-
#
|
|
3102
|
+
# @OutputOnly Cloud resource name of the consumer of this service. For example '
|
|
3103
|
+
# projects/123456'.
|
|
3700
3104
|
# Corresponds to the JSON property `consumer`
|
|
3701
3105
|
# @return [String]
|
|
3702
3106
|
attr_accessor :consumer
|
|
@@ -3706,21 +3110,20 @@ module Google
|
|
|
3706
3110
|
# @return [String]
|
|
3707
3111
|
attr_accessor :create_time
|
|
3708
3112
|
|
|
3709
|
-
# Globally unique identifier of this tenancy unit
|
|
3710
|
-
#
|
|
3113
|
+
# Globally unique identifier of this tenancy unit "services/`service`/`
|
|
3114
|
+
# collection id`/`resource id`/tenancyUnits/`unit`"
|
|
3711
3115
|
# Corresponds to the JSON property `name`
|
|
3712
3116
|
# @return [String]
|
|
3713
3117
|
attr_accessor :name
|
|
3714
3118
|
|
|
3715
|
-
# Output only. Google Cloud API name of the managed service owning this
|
|
3716
|
-
#
|
|
3717
|
-
# For example 'serviceconsumermanagement.googleapis.com'.
|
|
3119
|
+
# Output only. Google Cloud API name of the managed service owning this tenancy
|
|
3120
|
+
# unit. For example 'serviceconsumermanagement.googleapis.com'.
|
|
3718
3121
|
# Corresponds to the JSON property `service`
|
|
3719
3122
|
# @return [String]
|
|
3720
3123
|
attr_accessor :service
|
|
3721
3124
|
|
|
3722
|
-
# Resources constituting the tenancy unit.
|
|
3723
|
-
#
|
|
3125
|
+
# Resources constituting the tenancy unit. There can be at most 512 tenant
|
|
3126
|
+
# resources in a tenancy unit.
|
|
3724
3127
|
# Corresponds to the JSON property `tenantResources`
|
|
3725
3128
|
# @return [Array<Google::Apis::ServiceconsumermanagementV1::TenantResource>]
|
|
3726
3129
|
attr_accessor :tenant_resources
|
|
@@ -3751,11 +3154,10 @@ module Google
|
|
|
3751
3154
|
# @return [Google::Apis::ServiceconsumermanagementV1::BillingConfig]
|
|
3752
3155
|
attr_accessor :billing_config
|
|
3753
3156
|
|
|
3754
|
-
# Folder where project in this tenancy unit must be located
|
|
3755
|
-
#
|
|
3756
|
-
#
|
|
3757
|
-
#
|
|
3758
|
-
# (for example, `folders/123456`).
|
|
3157
|
+
# Folder where project in this tenancy unit must be located This folder must
|
|
3158
|
+
# have been previously created with the required permissions for the caller to
|
|
3159
|
+
# create and configure a project in it. Valid folder resource names have the
|
|
3160
|
+
# format `folders/`folder_number`` (for example, `folders/123456`).
|
|
3759
3161
|
# Corresponds to the JSON property `folder`
|
|
3760
3162
|
# @return [String]
|
|
3761
3163
|
attr_accessor :folder
|
|
@@ -3770,16 +3172,15 @@ module Google
|
|
|
3770
3172
|
# @return [Google::Apis::ServiceconsumermanagementV1::ServiceAccountConfig]
|
|
3771
3173
|
attr_accessor :service_account_config
|
|
3772
3174
|
|
|
3773
|
-
# Google Cloud API names of services that are activated on this project
|
|
3774
|
-
#
|
|
3775
|
-
# the request fails.
|
|
3175
|
+
# Google Cloud API names of services that are activated on this project during
|
|
3176
|
+
# provisioning. If any of these services can't be activated, the request fails.
|
|
3776
3177
|
# For example: 'compute.googleapis.com','cloudfunctions.googleapis.com'
|
|
3777
3178
|
# Corresponds to the JSON property `services`
|
|
3778
3179
|
# @return [Array<String>]
|
|
3779
3180
|
attr_accessor :services
|
|
3780
3181
|
|
|
3781
|
-
# Describes policy settings that need to be applied to a newly
|
|
3782
|
-
#
|
|
3182
|
+
# Describes policy settings that need to be applied to a newly created tenant
|
|
3183
|
+
# project.
|
|
3783
3184
|
# Corresponds to the JSON property `tenantProjectPolicy`
|
|
3784
3185
|
# @return [Google::Apis::ServiceconsumermanagementV1::TenantProjectPolicy]
|
|
3785
3186
|
attr_accessor :tenant_project_policy
|
|
@@ -3799,17 +3200,16 @@ module Google
|
|
|
3799
3200
|
end
|
|
3800
3201
|
end
|
|
3801
3202
|
|
|
3802
|
-
# Describes policy settings that need to be applied to a newly
|
|
3803
|
-
#
|
|
3203
|
+
# Describes policy settings that need to be applied to a newly created tenant
|
|
3204
|
+
# project.
|
|
3804
3205
|
class TenantProjectPolicy
|
|
3805
3206
|
include Google::Apis::Core::Hashable
|
|
3806
3207
|
|
|
3807
|
-
# Policy bindings to be applied to the tenant project, in addition to the
|
|
3808
|
-
#
|
|
3809
|
-
#
|
|
3810
|
-
#
|
|
3811
|
-
#
|
|
3812
|
-
# or `group` type.
|
|
3208
|
+
# Policy bindings to be applied to the tenant project, in addition to the 'roles/
|
|
3209
|
+
# owner' role granted to the Service Consumer Management service account. At
|
|
3210
|
+
# least one binding must have the role `roles/owner`. Among the list of members
|
|
3211
|
+
# for `roles/owner`, at least one of them must be either the `user` or `group`
|
|
3212
|
+
# type.
|
|
3813
3213
|
# Corresponds to the JSON property `policyBindings`
|
|
3814
3214
|
# @return [Array<Google::Apis::ServiceconsumermanagementV1::PolicyBinding>]
|
|
3815
3215
|
attr_accessor :policy_bindings
|
|
@@ -3828,9 +3228,8 @@ module Google
|
|
|
3828
3228
|
class TenantResource
|
|
3829
3229
|
include Google::Apis::Core::Hashable
|
|
3830
3230
|
|
|
3831
|
-
# @OutputOnly Identifier of the tenant resource.
|
|
3832
|
-
#
|
|
3833
|
-
# For example 'projects/123456'.
|
|
3231
|
+
# @OutputOnly Identifier of the tenant resource. For cloud projects, it is in
|
|
3232
|
+
# the form 'projects/`number`'. For example 'projects/123456'.
|
|
3834
3233
|
# Corresponds to the JSON property `resource`
|
|
3835
3234
|
# @return [String]
|
|
3836
3235
|
attr_accessor :resource
|
|
@@ -3881,8 +3280,8 @@ module Google
|
|
|
3881
3280
|
# @return [Array<Google::Apis::ServiceconsumermanagementV1::Option>]
|
|
3882
3281
|
attr_accessor :options
|
|
3883
3282
|
|
|
3884
|
-
# `SourceContext` represents information about the source of a
|
|
3885
|
-
#
|
|
3283
|
+
# `SourceContext` represents information about the source of a protobuf element,
|
|
3284
|
+
# like the file in which it is defined.
|
|
3886
3285
|
# Corresponds to the JSON property `sourceContext`
|
|
3887
3286
|
# @return [Google::Apis::ServiceconsumermanagementV1::SourceContext]
|
|
3888
3287
|
attr_accessor :source_context
|
|
@@ -3932,37 +3331,33 @@ module Google
|
|
|
3932
3331
|
include Google::Apis::Core::Hashable
|
|
3933
3332
|
|
|
3934
3333
|
# The full resource name of a channel used for sending notifications to the
|
|
3935
|
-
# service producer.
|
|
3936
|
-
#
|
|
3937
|
-
#
|
|
3938
|
-
#
|
|
3939
|
-
#
|
|
3940
|
-
# documented in https://cloud.google.com/pubsub/docs/overview.
|
|
3334
|
+
# service producer. Google Service Management currently only supports [Google
|
|
3335
|
+
# Cloud Pub/Sub](https://cloud.google.com/pubsub) as a notification channel. To
|
|
3336
|
+
# use Google Cloud Pub/Sub as the channel, this must be the name of a Cloud Pub/
|
|
3337
|
+
# Sub topic that uses the Cloud Pub/Sub topic name format documented in https://
|
|
3338
|
+
# cloud.google.com/pubsub/docs/overview.
|
|
3941
3339
|
# Corresponds to the JSON property `producerNotificationChannel`
|
|
3942
3340
|
# @return [String]
|
|
3943
3341
|
attr_accessor :producer_notification_channel
|
|
3944
3342
|
|
|
3945
3343
|
# Requirements that must be satisfied before a consumer project can use the
|
|
3946
|
-
# service. Each requirement is of the form
|
|
3947
|
-
#
|
|
3344
|
+
# service. Each requirement is of the form /; for example 'serviceusage.
|
|
3345
|
+
# googleapis.com/billing-enabled'.
|
|
3948
3346
|
# Corresponds to the JSON property `requirements`
|
|
3949
3347
|
# @return [Array<String>]
|
|
3950
3348
|
attr_accessor :requirements
|
|
3951
3349
|
|
|
3952
|
-
# A list of usage rules that apply to individual API methods.
|
|
3953
|
-
#
|
|
3350
|
+
# A list of usage rules that apply to individual API methods. **NOTE:** All
|
|
3351
|
+
# service configuration rules follow "last one wins" order.
|
|
3954
3352
|
# Corresponds to the JSON property `rules`
|
|
3955
3353
|
# @return [Array<Google::Apis::ServiceconsumermanagementV1::UsageRule>]
|
|
3956
3354
|
attr_accessor :rules
|
|
3957
3355
|
|
|
3958
|
-
# The per-product per-project service identity for a service.
|
|
3959
|
-
#
|
|
3960
|
-
#
|
|
3961
|
-
#
|
|
3962
|
-
#
|
|
3963
|
-
# - service_account_parent: "projects/123456789"
|
|
3964
|
-
# display_name: "Cloud XXX Service Agent"
|
|
3965
|
-
# description: "Used as the identity of Cloud XXX to access resources"
|
|
3356
|
+
# The per-product per-project service identity for a service. Use this field to
|
|
3357
|
+
# configure per-product per-project service identity. Example of a service
|
|
3358
|
+
# identity configuration. usage: service_identity: - service_account_parent: "
|
|
3359
|
+
# projects/123456789" display_name: "Cloud XXX Service Agent" description: "Used
|
|
3360
|
+
# as the identity of Cloud XXX to access resources"
|
|
3966
3361
|
# Corresponds to the JSON property `serviceIdentity`
|
|
3967
3362
|
# @return [Google::Apis::ServiceconsumermanagementV1::ServiceIdentity]
|
|
3968
3363
|
attr_accessor :service_identity
|
|
@@ -3980,45 +3375,36 @@ module Google
|
|
|
3980
3375
|
end
|
|
3981
3376
|
end
|
|
3982
3377
|
|
|
3983
|
-
# Usage configuration rules for the service.
|
|
3984
|
-
#
|
|
3985
|
-
#
|
|
3986
|
-
#
|
|
3987
|
-
#
|
|
3988
|
-
#
|
|
3989
|
-
#
|
|
3990
|
-
#
|
|
3991
|
-
#
|
|
3992
|
-
#
|
|
3993
|
-
# rules:
|
|
3994
|
-
# - selector: "*"
|
|
3995
|
-
# allow_unregistered_calls: true
|
|
3996
|
-
# Example of a method that wants to allow unregistered calls.
|
|
3997
|
-
# usage:
|
|
3998
|
-
# rules:
|
|
3999
|
-
# - selector: "google.example.library.v1.LibraryService.CreateBook"
|
|
4000
|
-
# allow_unregistered_calls: true
|
|
3378
|
+
# Usage configuration rules for the service. NOTE: Under development. Use this
|
|
3379
|
+
# rule to configure unregistered calls for the service. Unregistered calls are
|
|
3380
|
+
# calls that do not contain consumer project identity. (Example: calls that do
|
|
3381
|
+
# not contain an API key). By default, API methods do not allow unregistered
|
|
3382
|
+
# calls, and each method call must be identified by a consumer project identity.
|
|
3383
|
+
# Use this rule to allow/disallow unregistered calls. Example of an API that
|
|
3384
|
+
# wants to allow unregistered calls for entire service. usage: rules: - selector:
|
|
3385
|
+
# "*" allow_unregistered_calls: true Example of a method that wants to allow
|
|
3386
|
+
# unregistered calls. usage: rules: - selector: "google.example.library.v1.
|
|
3387
|
+
# LibraryService.CreateBook" allow_unregistered_calls: true
|
|
4001
3388
|
class UsageRule
|
|
4002
3389
|
include Google::Apis::Core::Hashable
|
|
4003
3390
|
|
|
4004
|
-
# If true, the selected method allows unregistered calls, e.g. calls
|
|
4005
|
-
#
|
|
3391
|
+
# If true, the selected method allows unregistered calls, e.g. calls that don't
|
|
3392
|
+
# identify any user or application.
|
|
4006
3393
|
# Corresponds to the JSON property `allowUnregisteredCalls`
|
|
4007
3394
|
# @return [Boolean]
|
|
4008
3395
|
attr_accessor :allow_unregistered_calls
|
|
4009
3396
|
alias_method :allow_unregistered_calls?, :allow_unregistered_calls
|
|
4010
3397
|
|
|
4011
3398
|
# Selects the methods to which this rule applies. Use '*' to indicate all
|
|
4012
|
-
# methods in all APIs.
|
|
4013
|
-
# Refer to selector for syntax details.
|
|
3399
|
+
# methods in all APIs. Refer to selector for syntax details.
|
|
4014
3400
|
# Corresponds to the JSON property `selector`
|
|
4015
3401
|
# @return [String]
|
|
4016
3402
|
attr_accessor :selector
|
|
4017
3403
|
|
|
4018
|
-
# If true, the selected method should skip service control and the control
|
|
4019
|
-
#
|
|
4020
|
-
#
|
|
4021
|
-
#
|
|
3404
|
+
# If true, the selected method should skip service control and the control plane
|
|
3405
|
+
# features, such as quota and billing, will not be available. This flag is used
|
|
3406
|
+
# by Google Cloud Endpoints to bypass checks for internal methods, such as
|
|
3407
|
+
# service health check methods.
|
|
4022
3408
|
# Corresponds to the JSON property `skipServiceControl`
|
|
4023
3409
|
# @return [Boolean]
|
|
4024
3410
|
attr_accessor :skip_service_control
|
|
@@ -4036,9 +3422,9 @@ module Google
|
|
|
4036
3422
|
end
|
|
4037
3423
|
end
|
|
4038
3424
|
|
|
4039
|
-
# Response message for the `AddVisibilityLabels` method.
|
|
4040
|
-
#
|
|
4041
|
-
#
|
|
3425
|
+
# Response message for the `AddVisibilityLabels` method. This response message
|
|
3426
|
+
# is assigned to the `response` field of the returned Operation when that
|
|
3427
|
+
# operation is done.
|
|
4042
3428
|
class V1AddVisibilityLabelsResponse
|
|
4043
3429
|
include Google::Apis::Core::Hashable
|
|
4044
3430
|
|
|
@@ -4076,9 +3462,9 @@ module Google
|
|
|
4076
3462
|
end
|
|
4077
3463
|
end
|
|
4078
3464
|
|
|
4079
|
-
# Response message for the `DisableConsumer` method.
|
|
4080
|
-
#
|
|
4081
|
-
#
|
|
3465
|
+
# Response message for the `DisableConsumer` method. This response message is
|
|
3466
|
+
# assigned to the `response` field of the returned Operation when that operation
|
|
3467
|
+
# is done.
|
|
4082
3468
|
class V1Beta1DisableConsumerResponse
|
|
4083
3469
|
include Google::Apis::Core::Hashable
|
|
4084
3470
|
|
|
@@ -4091,9 +3477,9 @@ module Google
|
|
|
4091
3477
|
end
|
|
4092
3478
|
end
|
|
4093
3479
|
|
|
4094
|
-
# Response message for the `EnableConsumer` method.
|
|
4095
|
-
#
|
|
4096
|
-
#
|
|
3480
|
+
# Response message for the `EnableConsumer` method. This response message is
|
|
3481
|
+
# assigned to the `response` field of the returned Operation when that operation
|
|
3482
|
+
# is done.
|
|
4097
3483
|
class V1Beta1EnableConsumerResponse
|
|
4098
3484
|
include Google::Apis::Core::Hashable
|
|
4099
3485
|
|
|
@@ -4106,9 +3492,9 @@ module Google
|
|
|
4106
3492
|
end
|
|
4107
3493
|
end
|
|
4108
3494
|
|
|
4109
|
-
# Response message for the `GenerateServiceIdentity` method.
|
|
4110
|
-
#
|
|
4111
|
-
#
|
|
3495
|
+
# Response message for the `GenerateServiceIdentity` method. This response
|
|
3496
|
+
# message is assigned to the `response` field of the returned Operation when
|
|
3497
|
+
# that operation is done.
|
|
4112
3498
|
class V1Beta1GenerateServiceIdentityResponse
|
|
4113
3499
|
include Google::Apis::Core::Hashable
|
|
4114
3500
|
|
|
@@ -4169,61 +3555,54 @@ module Google
|
|
|
4169
3555
|
class V1Beta1ProducerQuotaPolicy
|
|
4170
3556
|
include Google::Apis::Core::Hashable
|
|
4171
3557
|
|
|
4172
|
-
# The cloud resource container at which the quota policy is created. The
|
|
4173
|
-
#
|
|
3558
|
+
# The cloud resource container at which the quota policy is created. The format
|
|
3559
|
+
# is `container_type`/`container_number`
|
|
4174
3560
|
# Corresponds to the JSON property `container`
|
|
4175
3561
|
# @return [String]
|
|
4176
3562
|
attr_accessor :container
|
|
4177
3563
|
|
|
4178
|
-
# If this map is nonempty, then this policy applies only to specific values
|
|
4179
|
-
#
|
|
4180
|
-
#
|
|
4181
|
-
#
|
|
4182
|
-
#
|
|
4183
|
-
#
|
|
4184
|
-
#
|
|
4185
|
-
#
|
|
4186
|
-
#
|
|
4187
|
-
# *
|
|
4188
|
-
#
|
|
4189
|
-
# *
|
|
4190
|
-
#
|
|
4191
|
-
# * If "region" appears as a key, its value must be a valid Cloud region.
|
|
4192
|
-
# * If "zone" appears as a key, its value must be a valid Cloud zone.
|
|
4193
|
-
# * If any valid key other than "region" or "zone" appears in the map, then
|
|
4194
|
-
# all valid keys other than "region" or "zone" must also appear in the
|
|
3564
|
+
# If this map is nonempty, then this policy applies only to specific values for
|
|
3565
|
+
# dimensions defined in the limit unit. For example, an policy on a limit with
|
|
3566
|
+
# the unit 1/`project`/`region` could contain an entry with the key "region" and
|
|
3567
|
+
# the value "us-east-1"; the policy is only applied to quota consumed in that
|
|
3568
|
+
# region. This map has the following restrictions: * Keys that are not defined
|
|
3569
|
+
# in the limit's unit are not valid keys. Any string appearing in `brackets` in
|
|
3570
|
+
# the unit (besides `project` or `user`) is a defined key. * "project" is not a
|
|
3571
|
+
# valid key; the project is already specified in the parent resource name. * "
|
|
3572
|
+
# user" is not a valid key; the API does not support quota polcies that apply
|
|
3573
|
+
# only to a specific user. * If "region" appears as a key, its value must be a
|
|
3574
|
+
# valid Cloud region. * If "zone" appears as a key, its value must be a valid
|
|
3575
|
+
# Cloud zone. * If any valid key other than "region" or "zone" appears in the
|
|
3576
|
+
# map, then all valid keys other than "region" or "zone" must also appear in the
|
|
4195
3577
|
# map.
|
|
4196
3578
|
# Corresponds to the JSON property `dimensions`
|
|
4197
3579
|
# @return [Hash<String,String>]
|
|
4198
3580
|
attr_accessor :dimensions
|
|
4199
3581
|
|
|
4200
|
-
# The name of the metric to which this policy applies.
|
|
4201
|
-
# An example name would be:
|
|
3582
|
+
# The name of the metric to which this policy applies. An example name would be:
|
|
4202
3583
|
# `compute.googleapis.com/cpus`
|
|
4203
3584
|
# Corresponds to the JSON property `metric`
|
|
4204
3585
|
# @return [String]
|
|
4205
3586
|
attr_accessor :metric
|
|
4206
3587
|
|
|
4207
|
-
# The resource name of the producer policy.
|
|
4208
|
-
#
|
|
4209
|
-
#
|
|
4210
|
-
# compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/producerQuotaPolicies/
|
|
3588
|
+
# The resource name of the producer policy. An example name would be: `services/
|
|
3589
|
+
# compute.googleapis.com/organizations/123/consumerQuotaMetrics/compute.
|
|
3590
|
+
# googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/producerQuotaPolicies/
|
|
4211
3591
|
# 4a3f2c1d`
|
|
4212
3592
|
# Corresponds to the JSON property `name`
|
|
4213
3593
|
# @return [String]
|
|
4214
3594
|
attr_accessor :name
|
|
4215
3595
|
|
|
4216
|
-
# The quota policy value.
|
|
4217
|
-
#
|
|
3596
|
+
# The quota policy value. Can be any nonnegative integer, or -1 (unlimited quota)
|
|
3597
|
+
# .
|
|
4218
3598
|
# Corresponds to the JSON property `policyValue`
|
|
4219
3599
|
# @return [Fixnum]
|
|
4220
3600
|
attr_accessor :policy_value
|
|
4221
3601
|
|
|
4222
|
-
# The limit unit of the limit to which this policy applies.
|
|
4223
|
-
#
|
|
4224
|
-
#
|
|
4225
|
-
#
|
|
4226
|
-
# the literal characters ``` and ``` occur in the string.
|
|
3602
|
+
# The limit unit of the limit to which this policy applies. An example unit
|
|
3603
|
+
# would be: `1/`project`/`region`` Note that ``project`` and ``region`` are not
|
|
3604
|
+
# placeholders in this example; the literal characters ``` and ``` occur in the
|
|
3605
|
+
# string.
|
|
4227
3606
|
# Corresponds to the JSON property `unit`
|
|
4228
3607
|
# @return [String]
|
|
4229
3608
|
attr_accessor :unit
|
|
@@ -4247,61 +3626,53 @@ module Google
|
|
|
4247
3626
|
class V1Beta1QuotaOverride
|
|
4248
3627
|
include Google::Apis::Core::Hashable
|
|
4249
3628
|
|
|
4250
|
-
# The resource name of the ancestor that requested the override. For example:
|
|
4251
|
-
#
|
|
4252
|
-
# Used by admin overrides only.
|
|
3629
|
+
# The resource name of the ancestor that requested the override. For example: "
|
|
3630
|
+
# organizations/12345" or "folders/67890". Used by admin overrides only.
|
|
4253
3631
|
# Corresponds to the JSON property `adminOverrideAncestor`
|
|
4254
3632
|
# @return [String]
|
|
4255
3633
|
attr_accessor :admin_override_ancestor
|
|
4256
3634
|
|
|
4257
3635
|
# If this map is nonempty, then this override applies only to specific values
|
|
4258
|
-
# for dimensions defined in the limit unit.
|
|
4259
|
-
#
|
|
4260
|
-
#
|
|
4261
|
-
#
|
|
4262
|
-
#
|
|
4263
|
-
#
|
|
4264
|
-
#
|
|
4265
|
-
#
|
|
4266
|
-
#
|
|
4267
|
-
#
|
|
4268
|
-
#
|
|
4269
|
-
#
|
|
4270
|
-
#
|
|
4271
|
-
# * If "zone" appears as a key, its value must be a valid Cloud zone.
|
|
4272
|
-
# * If any valid key other than "region" or "zone" appears in the map, then
|
|
4273
|
-
# all valid keys other than "region" or "zone" must also appear in the
|
|
4274
|
-
# map.
|
|
3636
|
+
# for dimensions defined in the limit unit. For example, an override on a limit
|
|
3637
|
+
# with the unit 1/`project`/`region` could contain an entry with the key "region"
|
|
3638
|
+
# and the value "us-east-1"; the override is only applied to quota consumed in
|
|
3639
|
+
# that region. This map has the following restrictions: * Keys that are not
|
|
3640
|
+
# defined in the limit's unit are not valid keys. Any string appearing in `
|
|
3641
|
+
# brackets` in the unit (besides `project` or `user`) is a defined key. * "
|
|
3642
|
+
# project" is not a valid key; the project is already specified in the parent
|
|
3643
|
+
# resource name. * "user" is not a valid key; the API does not support quota
|
|
3644
|
+
# overrides that apply only to a specific user. * If "region" appears as a key,
|
|
3645
|
+
# its value must be a valid Cloud region. * If "zone" appears as a key, its
|
|
3646
|
+
# value must be a valid Cloud zone. * If any valid key other than "region" or "
|
|
3647
|
+
# zone" appears in the map, then all valid keys other than "region" or "zone"
|
|
3648
|
+
# must also appear in the map.
|
|
4275
3649
|
# Corresponds to the JSON property `dimensions`
|
|
4276
3650
|
# @return [Hash<String,String>]
|
|
4277
3651
|
attr_accessor :dimensions
|
|
4278
3652
|
|
|
4279
|
-
# The name of the metric to which this override applies.
|
|
4280
|
-
#
|
|
4281
|
-
# `compute.googleapis.com/cpus`
|
|
3653
|
+
# The name of the metric to which this override applies. An example name would
|
|
3654
|
+
# be: `compute.googleapis.com/cpus`
|
|
4282
3655
|
# Corresponds to the JSON property `metric`
|
|
4283
3656
|
# @return [String]
|
|
4284
3657
|
attr_accessor :metric
|
|
4285
3658
|
|
|
4286
|
-
# The resource name of the producer override.
|
|
4287
|
-
#
|
|
4288
|
-
# `services/compute.googleapis.com/projects/123/consumerQuotaMetrics/compute.
|
|
3659
|
+
# The resource name of the producer override. An example name would be: `
|
|
3660
|
+
# services/compute.googleapis.com/projects/123/consumerQuotaMetrics/compute.
|
|
4289
3661
|
# googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/producerOverrides/4a3f2c1d`
|
|
4290
3662
|
# Corresponds to the JSON property `name`
|
|
4291
3663
|
# @return [String]
|
|
4292
3664
|
attr_accessor :name
|
|
4293
3665
|
|
|
4294
|
-
# The overriding quota limit value.
|
|
4295
|
-
#
|
|
3666
|
+
# The overriding quota limit value. Can be any nonnegative integer, or -1 (
|
|
3667
|
+
# unlimited quota).
|
|
4296
3668
|
# Corresponds to the JSON property `overrideValue`
|
|
4297
3669
|
# @return [Fixnum]
|
|
4298
3670
|
attr_accessor :override_value
|
|
4299
3671
|
|
|
4300
|
-
# The limit unit of the limit to which this override applies.
|
|
4301
|
-
#
|
|
4302
|
-
#
|
|
4303
|
-
#
|
|
4304
|
-
# the literal characters ``` and ``` occur in the string.
|
|
3672
|
+
# The limit unit of the limit to which this override applies. An example unit
|
|
3673
|
+
# would be: `1/`project`/`region`` Note that ``project`` and ``region`` are not
|
|
3674
|
+
# placeholders in this example; the literal characters ``` and ``` occur in the
|
|
3675
|
+
# string.
|
|
4305
3676
|
# Corresponds to the JSON property `unit`
|
|
4306
3677
|
# @return [String]
|
|
4307
3678
|
attr_accessor :unit
|
|
@@ -4321,9 +3692,9 @@ module Google
|
|
|
4321
3692
|
end
|
|
4322
3693
|
end
|
|
4323
3694
|
|
|
4324
|
-
# Response message for the `RefreshConsumer` method.
|
|
4325
|
-
#
|
|
4326
|
-
#
|
|
3695
|
+
# Response message for the `RefreshConsumer` method. This response message is
|
|
3696
|
+
# assigned to the `response` field of the returned Operation when that operation
|
|
3697
|
+
# is done.
|
|
4327
3698
|
class V1Beta1RefreshConsumerResponse
|
|
4328
3699
|
include Google::Apis::Core::Hashable
|
|
4329
3700
|
|
|
@@ -4345,17 +3716,16 @@ module Google
|
|
|
4345
3716
|
# @return [String]
|
|
4346
3717
|
attr_accessor :email
|
|
4347
3718
|
|
|
4348
|
-
# P4 service identity resource name.
|
|
4349
|
-
#
|
|
4350
|
-
# `
|
|
4351
|
-
# serviceIdentities/default`
|
|
3719
|
+
# P4 service identity resource name. An example name would be: `services/
|
|
3720
|
+
# serviceconsumermanagement.googleapis.com/projects/123/serviceIdentities/
|
|
3721
|
+
# default`
|
|
4352
3722
|
# Corresponds to the JSON property `name`
|
|
4353
3723
|
# @return [String]
|
|
4354
3724
|
attr_accessor :name
|
|
4355
3725
|
|
|
4356
3726
|
# The P4 service identity configuration tag. This must be defined in
|
|
4357
|
-
# activation_grants. If not specified when creating the account, the tag is
|
|
4358
|
-
#
|
|
3727
|
+
# activation_grants. If not specified when creating the account, the tag is set
|
|
3728
|
+
# to "default".
|
|
4359
3729
|
# Corresponds to the JSON property `tag`
|
|
4360
3730
|
# @return [String]
|
|
4361
3731
|
attr_accessor :tag
|
|
@@ -4387,10 +3757,8 @@ module Google
|
|
|
4387
3757
|
# @return [String]
|
|
4388
3758
|
attr_accessor :email
|
|
4389
3759
|
|
|
4390
|
-
# Default identity resource name.
|
|
4391
|
-
#
|
|
4392
|
-
# `services/serviceconsumermanagement.googleapis.com/projects/123/
|
|
4393
|
-
# defaultIdentity`
|
|
3760
|
+
# Default identity resource name. An example name would be: `services/
|
|
3761
|
+
# serviceconsumermanagement.googleapis.com/projects/123/defaultIdentity`
|
|
4394
3762
|
# Corresponds to the JSON property `name`
|
|
4395
3763
|
# @return [String]
|
|
4396
3764
|
attr_accessor :name
|
|
@@ -4412,9 +3780,9 @@ module Google
|
|
|
4412
3780
|
end
|
|
4413
3781
|
end
|
|
4414
3782
|
|
|
4415
|
-
# Response message for the `DisableConsumer` method.
|
|
4416
|
-
#
|
|
4417
|
-
#
|
|
3783
|
+
# Response message for the `DisableConsumer` method. This response message is
|
|
3784
|
+
# assigned to the `response` field of the returned Operation when that operation
|
|
3785
|
+
# is done.
|
|
4418
3786
|
class V1DisableConsumerResponse
|
|
4419
3787
|
include Google::Apis::Core::Hashable
|
|
4420
3788
|
|
|
@@ -4427,9 +3795,9 @@ module Google
|
|
|
4427
3795
|
end
|
|
4428
3796
|
end
|
|
4429
3797
|
|
|
4430
|
-
# Response message for the `EnableConsumer` method.
|
|
4431
|
-
#
|
|
4432
|
-
#
|
|
3798
|
+
# Response message for the `EnableConsumer` method. This response message is
|
|
3799
|
+
# assigned to the `response` field of the returned Operation when that operation
|
|
3800
|
+
# is done.
|
|
4433
3801
|
class V1EnableConsumerResponse
|
|
4434
3802
|
include Google::Apis::Core::Hashable
|
|
4435
3803
|
|
|
@@ -4442,9 +3810,9 @@ module Google
|
|
|
4442
3810
|
end
|
|
4443
3811
|
end
|
|
4444
3812
|
|
|
4445
|
-
# Response message for the `GenerateDefaultIdentity` method.
|
|
4446
|
-
#
|
|
4447
|
-
#
|
|
3813
|
+
# Response message for the `GenerateDefaultIdentity` method. This response
|
|
3814
|
+
# message is assigned to the `response` field of the returned Operation when
|
|
3815
|
+
# that operation is done.
|
|
4448
3816
|
class V1GenerateDefaultIdentityResponse
|
|
4449
3817
|
include Google::Apis::Core::Hashable
|
|
4450
3818
|
|
|
@@ -4459,8 +3827,8 @@ module Google
|
|
|
4459
3827
|
# @return [Google::Apis::ServiceconsumermanagementV1::V1DefaultIdentity]
|
|
4460
3828
|
attr_accessor :identity
|
|
4461
3829
|
|
|
4462
|
-
# Role attached to consumer project. Empty if not attached in this
|
|
4463
|
-
#
|
|
3830
|
+
# Role attached to consumer project. Empty if not attached in this request. (
|
|
3831
|
+
# Under development, currently always return empty.)
|
|
4464
3832
|
# Corresponds to the JSON property `role`
|
|
4465
3833
|
# @return [String]
|
|
4466
3834
|
attr_accessor :role
|
|
@@ -4477,9 +3845,9 @@ module Google
|
|
|
4477
3845
|
end
|
|
4478
3846
|
end
|
|
4479
3847
|
|
|
4480
|
-
# Response message for the `GenerateServiceAccount` method.
|
|
4481
|
-
#
|
|
4482
|
-
#
|
|
3848
|
+
# Response message for the `GenerateServiceAccount` method. This response
|
|
3849
|
+
# message is assigned to the `response` field of the returned Operation when
|
|
3850
|
+
# that operation is done.
|
|
4483
3851
|
class V1GenerateServiceAccountResponse
|
|
4484
3852
|
include Google::Apis::Core::Hashable
|
|
4485
3853
|
|
|
@@ -4498,9 +3866,9 @@ module Google
|
|
|
4498
3866
|
end
|
|
4499
3867
|
end
|
|
4500
3868
|
|
|
4501
|
-
# Response message for the `RefreshConsumer` method.
|
|
4502
|
-
#
|
|
4503
|
-
#
|
|
3869
|
+
# Response message for the `RefreshConsumer` method. This response message is
|
|
3870
|
+
# assigned to the `response` field of the returned Operation when that operation
|
|
3871
|
+
# is done.
|
|
4504
3872
|
class V1RefreshConsumerResponse
|
|
4505
3873
|
include Google::Apis::Core::Hashable
|
|
4506
3874
|
|
|
@@ -4513,9 +3881,9 @@ module Google
|
|
|
4513
3881
|
end
|
|
4514
3882
|
end
|
|
4515
3883
|
|
|
4516
|
-
# Response message for the `RemoveVisibilityLabels` method.
|
|
4517
|
-
#
|
|
4518
|
-
#
|
|
3884
|
+
# Response message for the `RemoveVisibilityLabels` method. This response
|
|
3885
|
+
# message is assigned to the `response` field of the returned Operation when
|
|
3886
|
+
# that operation is done.
|
|
4519
3887
|
class V1RemoveVisibilityLabelsResponse
|
|
4520
3888
|
include Google::Apis::Core::Hashable
|
|
4521
3889
|
|
|
@@ -4548,16 +3916,14 @@ module Google
|
|
|
4548
3916
|
# @return [String]
|
|
4549
3917
|
attr_accessor :iam_account_name
|
|
4550
3918
|
|
|
4551
|
-
# P4 SA resource name.
|
|
4552
|
-
#
|
|
4553
|
-
# `services/serviceconsumermanagement.googleapis.com/projects/123/
|
|
4554
|
-
# serviceAccounts/default`
|
|
3919
|
+
# P4 SA resource name. An example name would be: `services/
|
|
3920
|
+
# serviceconsumermanagement.googleapis.com/projects/123/serviceAccounts/default`
|
|
4555
3921
|
# Corresponds to the JSON property `name`
|
|
4556
3922
|
# @return [String]
|
|
4557
3923
|
attr_accessor :name
|
|
4558
3924
|
|
|
4559
|
-
# The P4 SA configuration tag. This must be defined in activation_grants.
|
|
4560
|
-
#
|
|
3925
|
+
# The P4 SA configuration tag. This must be defined in activation_grants. If not
|
|
3926
|
+
# specified when creating the account, the tag is set to "default".
|
|
4561
3927
|
# Corresponds to the JSON property `tag`
|
|
4562
3928
|
# @return [String]
|
|
4563
3929
|
attr_accessor :tag
|