google-api-client 0.42.2 → 0.43.0
Sign up to get free protection for your applications and to get access to all the features.
- 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
@@ -48,15 +48,13 @@ module Google
|
|
48
48
|
@batch_path = 'batch'
|
49
49
|
end
|
50
50
|
|
51
|
-
# Starts asynchronous cancellation on a long-running operation.
|
52
|
-
#
|
53
|
-
#
|
54
|
-
#
|
55
|
-
#
|
56
|
-
#
|
57
|
-
# operation
|
58
|
-
# the operation is not deleted; instead, it becomes an operation with
|
59
|
-
# an Operation.error value with a google.rpc.Status.code of 1,
|
51
|
+
# Starts asynchronous cancellation on a long-running operation. The server makes
|
52
|
+
# a best effort to cancel the operation, but success is not guaranteed. If the
|
53
|
+
# server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
|
54
|
+
# Clients can use Operations.GetOperation or other methods to check whether the
|
55
|
+
# cancellation succeeded or whether the operation completed despite cancellation.
|
56
|
+
# On successful cancellation, the operation is not deleted; instead, it becomes
|
57
|
+
# an operation with an Operation.error value with a google.rpc.Status.code of 1,
|
60
58
|
# corresponding to `Code.CANCELLED`.
|
61
59
|
# @param [String] name
|
62
60
|
# The name of the operation resource to be cancelled.
|
@@ -90,10 +88,10 @@ module Google
|
|
90
88
|
execute_or_queue_command(command, &block)
|
91
89
|
end
|
92
90
|
|
93
|
-
# Deletes a long-running operation. This method indicates that the client is
|
94
|
-
#
|
95
|
-
#
|
96
|
-
#
|
91
|
+
# Deletes a long-running operation. This method indicates that the client is no
|
92
|
+
# longer interested in the operation result. It does not cancel the operation.
|
93
|
+
# If the server doesn't support this method, it returns `google.rpc.Code.
|
94
|
+
# UNIMPLEMENTED`.
|
97
95
|
# @param [String] name
|
98
96
|
# The name of the operation resource to be deleted.
|
99
97
|
# @param [String] fields
|
@@ -123,9 +121,8 @@ module Google
|
|
123
121
|
execute_or_queue_command(command, &block)
|
124
122
|
end
|
125
123
|
|
126
|
-
# Gets the latest state of a long-running operation.
|
127
|
-
#
|
128
|
-
# service.
|
124
|
+
# Gets the latest state of a long-running operation. Clients can use this method
|
125
|
+
# to poll the operation result at intervals as recommended by the API service.
|
129
126
|
# @param [String] name
|
130
127
|
# The name of the operation resource.
|
131
128
|
# @param [String] fields
|
@@ -155,15 +152,14 @@ module Google
|
|
155
152
|
execute_or_queue_command(command, &block)
|
156
153
|
end
|
157
154
|
|
158
|
-
# Lists operations that match the specified filter in the request. If the
|
159
|
-
#
|
160
|
-
#
|
161
|
-
#
|
162
|
-
#
|
163
|
-
#
|
164
|
-
#
|
165
|
-
#
|
166
|
-
# is the parent resource, without the operations collection id.
|
155
|
+
# Lists operations that match the specified filter in the request. If the server
|
156
|
+
# doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name`
|
157
|
+
# binding allows API services to override the binding to use different resource
|
158
|
+
# name schemes, such as `users/*/operations`. To override the binding, API
|
159
|
+
# services can add a binding such as `"/v1/`name=users/*`/operations"` to their
|
160
|
+
# service configuration. For backwards compatibility, the default name includes
|
161
|
+
# the operations collection id, however overriding users must ensure the name
|
162
|
+
# binding is the parent resource, without the operations collection id.
|
167
163
|
# @param [String] name
|
168
164
|
# The name of the operation's parent resource.
|
169
165
|
# @param [String] filter
|
@@ -204,20 +200,18 @@ module Google
|
|
204
200
|
|
205
201
|
# For service producers, provisions a new subnet in a peered service's shared
|
206
202
|
# VPC network in the requested region and with the requested size that's
|
207
|
-
# expressed as a CIDR range (number of leading bits of ipV4 network mask).
|
208
|
-
#
|
209
|
-
#
|
210
|
-
#
|
211
|
-
#
|
212
|
-
# project as needed.
|
203
|
+
# expressed as a CIDR range (number of leading bits of ipV4 network mask). The
|
204
|
+
# method checks against the assigned allocated ranges to find a non-conflicting
|
205
|
+
# IP address range. The method will reuse a subnet if subsequent calls contain
|
206
|
+
# the same subnet name, region, and prefix length. This method will make
|
207
|
+
# producer's tenant project to be a shared VPC service project as needed.
|
213
208
|
# @param [String] parent
|
214
209
|
# Required. A tenant project in the service producer organization, in the
|
215
|
-
# following format: services/`service`/`collection-id`/`resource-id`.
|
216
|
-
#
|
217
|
-
# tenant project. Only `projects` are supported.
|
218
|
-
#
|
219
|
-
#
|
220
|
-
# `service-peering.example.com`. This service must already be
|
210
|
+
# following format: services/`service`/`collection-id`/`resource-id`. `
|
211
|
+
# collection-id` is the cloud resource collection type that represents the
|
212
|
+
# tenant project. Only `projects` are supported. `resource-id` is the tenant
|
213
|
+
# project numeric id, such as `123456`. `service` the name of the peering
|
214
|
+
# service, such as `service-peering.example.com`. This service must already be
|
221
215
|
# enabled in the service consumer's project.
|
222
216
|
# @param [Google::Apis::ServicenetworkingV1::AddSubnetworkRequest] add_subnetwork_request_object
|
223
217
|
# @param [String] fields
|
@@ -252,8 +246,8 @@ module Google
|
|
252
246
|
# Disables VPC service controls for a connection.
|
253
247
|
# @param [String] parent
|
254
248
|
# The service that is managing peering connectivity for a service producer's
|
255
|
-
# organization. For Google services that support this functionality, this
|
256
|
-
#
|
249
|
+
# organization. For Google services that support this functionality, this value
|
250
|
+
# is `services/servicenetworking.googleapis.com`.
|
257
251
|
# @param [Google::Apis::ServicenetworkingV1::DisableVpcServiceControlsRequest] disable_vpc_service_controls_request_object
|
258
252
|
# @param [String] fields
|
259
253
|
# Selector specifying which fields to include in a partial response.
|
@@ -287,8 +281,8 @@ module Google
|
|
287
281
|
# Enables VPC service controls for a connection.
|
288
282
|
# @param [String] parent
|
289
283
|
# The service that is managing peering connectivity for a service producer's
|
290
|
-
# organization. For Google services that support this functionality, this
|
291
|
-
#
|
284
|
+
# organization. For Google services that support this functionality, this value
|
285
|
+
# is `services/servicenetworking.googleapis.com`.
|
292
286
|
# @param [Google::Apis::ServicenetworkingV1::EnableVpcServiceControlsRequest] enable_vpc_service_controls_request_object
|
293
287
|
# @param [String] fields
|
294
288
|
# Selector specifying which fields to include in a partial response.
|
@@ -319,16 +313,14 @@ module Google
|
|
319
313
|
execute_or_queue_command(command, &block)
|
320
314
|
end
|
321
315
|
|
322
|
-
# Service producers can use this method to find a currently unused range
|
323
|
-
#
|
324
|
-
#
|
325
|
-
#
|
326
|
-
#
|
327
|
-
# notation).
|
316
|
+
# Service producers can use this method to find a currently unused range within
|
317
|
+
# consumer allocated ranges. This returned range is not reserved, and not
|
318
|
+
# guaranteed to remain unused. It will validate previously provided allocated
|
319
|
+
# ranges, find non-conflicting sub-range of requested size (expressed in number
|
320
|
+
# of leading bits of ipv4 network mask, as in CIDR range notation).
|
328
321
|
# @param [String] parent
|
329
322
|
# Required. This is in a form services/`service`. `service` the name of the
|
330
|
-
# private
|
331
|
-
# access management service, for example 'service-peering.example.com'.
|
323
|
+
# private access management service, for example 'service-peering.example.com'.
|
332
324
|
# @param [Google::Apis::ServicenetworkingV1::SearchRangeRequest] search_range_request_object
|
333
325
|
# @param [String] fields
|
334
326
|
# Selector specifying which fields to include in a partial response.
|
@@ -359,15 +351,14 @@ module Google
|
|
359
351
|
execute_or_queue_command(command, &block)
|
360
352
|
end
|
361
353
|
|
362
|
-
# Service producers use this method to validate if the consumer provided
|
363
|
-
#
|
364
|
-
#
|
365
|
-
#
|
354
|
+
# Service producers use this method to validate if the consumer provided network,
|
355
|
+
# project and requested range are valid. This allows them to use a fail-fast
|
356
|
+
# mechanism for consumer requests, and not have to wait for AddSubnetwork
|
357
|
+
# operation completion to determine if user request is invalid.
|
366
358
|
# @param [String] parent
|
367
359
|
# Required. This is in a form services/`service` where `service` is the name of
|
368
|
-
# the
|
369
|
-
#
|
370
|
-
# 'service-peering.example.com'.
|
360
|
+
# the private access management service. For example 'service-peering.example.
|
361
|
+
# com'.
|
371
362
|
# @param [Google::Apis::ServicenetworkingV1::ValidateConsumerConfigRequest] validate_consumer_config_request_object
|
372
363
|
# @param [String] fields
|
373
364
|
# Selector specifying which fields to include in a partial response.
|
@@ -398,17 +389,17 @@ module Google
|
|
398
389
|
execute_or_queue_command(command, &block)
|
399
390
|
end
|
400
391
|
|
401
|
-
# Creates a private connection that establishes a VPC Network Peering
|
402
|
-
#
|
403
|
-
#
|
404
|
-
#
|
405
|
-
#
|
406
|
-
#
|
407
|
-
#
|
392
|
+
# Creates a private connection that establishes a VPC Network Peering connection
|
393
|
+
# to a VPC network in the service producer's organization. The administrator of
|
394
|
+
# the service consumer's VPC network invokes this method. The administrator must
|
395
|
+
# assign one or more allocated IP ranges for provisioning subnetworks in the
|
396
|
+
# service producer's VPC network. This connection is used for all supported
|
397
|
+
# services in the service producer's organization, so it only needs to be
|
398
|
+
# invoked once.
|
408
399
|
# @param [String] parent
|
409
400
|
# The service that is managing peering connectivity for a service producer's
|
410
|
-
# organization. For Google services that support this functionality, this
|
411
|
-
#
|
401
|
+
# organization. For Google services that support this functionality, this value
|
402
|
+
# is `services/servicenetworking.googleapis.com`.
|
412
403
|
# @param [Google::Apis::ServicenetworkingV1::Connection] connection_object
|
413
404
|
# @param [String] fields
|
414
405
|
# Selector specifying which fields to include in a partial response.
|
@@ -439,22 +430,19 @@ module Google
|
|
439
430
|
execute_or_queue_command(command, &block)
|
440
431
|
end
|
441
432
|
|
442
|
-
# List the private connections that are configured in a service consumer's
|
443
|
-
#
|
433
|
+
# List the private connections that are configured in a service consumer's VPC
|
434
|
+
# network.
|
444
435
|
# @param [String] parent
|
445
436
|
# The service that is managing peering connectivity for a service producer's
|
446
|
-
# organization. For Google services that support this functionality, this
|
447
|
-
#
|
448
|
-
#
|
449
|
-
# services are listed.
|
437
|
+
# organization. For Google services that support this functionality, this value
|
438
|
+
# is `services/servicenetworking.googleapis.com`. If you specify `services/-` as
|
439
|
+
# the parameter value, all configured peering services are listed.
|
450
440
|
# @param [String] network
|
451
441
|
# The name of service consumer's VPC network that's connected with service
|
452
|
-
# producer network through a private connection. The network name must be in
|
453
|
-
#
|
454
|
-
#
|
455
|
-
#
|
456
|
-
# consumer's VPC network. `network` is the name of the service consumer's VPC
|
457
|
-
# network.
|
442
|
+
# producer network through a private connection. The network name must be in the
|
443
|
+
# following format: `projects/`project`/global/networks/`network``. `project` is
|
444
|
+
# a project number, such as in `12345` that includes the VPC service consumer's
|
445
|
+
# VPC network. `network` is the name of the service consumer's VPC network.
|
458
446
|
# @param [String] fields
|
459
447
|
# Selector specifying which fields to include in a partial response.
|
460
448
|
# @param [String] quota_user
|
@@ -487,18 +475,17 @@ module Google
|
|
487
475
|
# @param [String] name
|
488
476
|
# The private service connection that connects to a service producer
|
489
477
|
# organization. The name includes both the private service name and the VPC
|
490
|
-
# network peering name in the format of
|
491
|
-
#
|
492
|
-
#
|
493
|
-
#
|
494
|
-
# googleapis-com`.
|
478
|
+
# network peering name in the format of `services/`peering_service_name`/
|
479
|
+
# connections/`vpc_peering_name``. For Google services that support this
|
480
|
+
# functionality, this is `services/servicenetworking.googleapis.com/connections/
|
481
|
+
# servicenetworking-googleapis-com`.
|
495
482
|
# @param [Google::Apis::ServicenetworkingV1::Connection] connection_object
|
496
483
|
# @param [Boolean] force
|
497
|
-
# If a previously defined allocated range is removed, force flag must be
|
498
|
-
#
|
484
|
+
# If a previously defined allocated range is removed, force flag must be set to
|
485
|
+
# true.
|
499
486
|
# @param [String] update_mask
|
500
|
-
# The update mask. If this is omitted, it defaults to "*". You can only
|
501
|
-
#
|
487
|
+
# The update mask. If this is omitted, it defaults to "*". You can only update
|
488
|
+
# the listed peering ranges.
|
502
489
|
# @param [String] fields
|
503
490
|
# Selector specifying which fields to include in a partial response.
|
504
491
|
# @param [String] quota_user
|
@@ -534,9 +521,8 @@ module Google
|
|
534
521
|
# zones in the shared producer host project.
|
535
522
|
# @param [String] parent
|
536
523
|
# Required. The service that is managing peering connectivity for a service
|
537
|
-
# producer's
|
538
|
-
#
|
539
|
-
# value is `services/servicenetworking.googleapis.com`.
|
524
|
+
# producer's organization. For Google services that support this functionality,
|
525
|
+
# this value is `services/servicenetworking.googleapis.com`.
|
540
526
|
# @param [Google::Apis::ServicenetworkingV1::AddDnsRecordSetRequest] add_dns_record_set_request_object
|
541
527
|
# @param [String] fields
|
542
528
|
# Selector specifying which fields to include in a partial response.
|
@@ -567,13 +553,12 @@ module Google
|
|
567
553
|
execute_or_queue_command(command, &block)
|
568
554
|
end
|
569
555
|
|
570
|
-
# Service producers can use this method to remove DNS record sets from
|
571
|
-
#
|
556
|
+
# Service producers can use this method to remove DNS record sets from private
|
557
|
+
# DNS zones in the shared producer host project.
|
572
558
|
# @param [String] parent
|
573
559
|
# Required. The service that is managing peering connectivity for a service
|
574
|
-
# producer's
|
575
|
-
#
|
576
|
-
# value is `services/servicenetworking.googleapis.com`.
|
560
|
+
# producer's organization. For Google services that support this functionality,
|
561
|
+
# this value is `services/servicenetworking.googleapis.com`.
|
577
562
|
# @param [Google::Apis::ServicenetworkingV1::RemoveDnsRecordSetRequest] remove_dns_record_set_request_object
|
578
563
|
# @param [String] fields
|
579
564
|
# Selector specifying which fields to include in a partial response.
|
@@ -604,13 +589,12 @@ module Google
|
|
604
589
|
execute_or_queue_command(command, &block)
|
605
590
|
end
|
606
591
|
|
607
|
-
# Service producers can use this method to update DNS record sets from
|
608
|
-
#
|
592
|
+
# Service producers can use this method to update DNS record sets from private
|
593
|
+
# DNS zones in the shared producer host project.
|
609
594
|
# @param [String] parent
|
610
595
|
# Required. The service that is managing peering connectivity for a service
|
611
|
-
# producer's
|
612
|
-
#
|
613
|
-
# value is `services/servicenetworking.googleapis.com`.
|
596
|
+
# producer's organization. For Google services that support this functionality,
|
597
|
+
# this value is `services/servicenetworking.googleapis.com`.
|
614
598
|
# @param [Google::Apis::ServicenetworkingV1::UpdateDnsRecordSetRequest] update_dns_record_set_request_object
|
615
599
|
# @param [String] fields
|
616
600
|
# Selector specifying which fields to include in a partial response.
|
@@ -641,14 +625,12 @@ module Google
|
|
641
625
|
execute_or_queue_command(command, &block)
|
642
626
|
end
|
643
627
|
|
644
|
-
# Service producers can use this method to add private DNS zones in the
|
645
|
-
#
|
646
|
-
# project.
|
628
|
+
# Service producers can use this method to add private DNS zones in the shared
|
629
|
+
# producer host project and matching peering zones in the consumer project.
|
647
630
|
# @param [String] parent
|
648
631
|
# Required. The service that is managing peering connectivity for a service
|
649
|
-
# producer's
|
650
|
-
#
|
651
|
-
# value is `services/servicenetworking.googleapis.com`.
|
632
|
+
# producer's organization. For Google services that support this functionality,
|
633
|
+
# this value is `services/servicenetworking.googleapis.com`.
|
652
634
|
# @param [Google::Apis::ServicenetworkingV1::AddDnsZoneRequest] add_dns_zone_request_object
|
653
635
|
# @param [String] fields
|
654
636
|
# Selector specifying which fields to include in a partial response.
|
@@ -684,9 +666,8 @@ module Google
|
|
684
666
|
# project.
|
685
667
|
# @param [String] parent
|
686
668
|
# Required. The service that is managing peering connectivity for a service
|
687
|
-
# producer's
|
688
|
-
#
|
689
|
-
# value is `services/servicenetworking.googleapis.com`.
|
669
|
+
# producer's organization. For Google services that support this functionality,
|
670
|
+
# this value is `services/servicenetworking.googleapis.com`.
|
690
671
|
# @param [Google::Apis::ServicenetworkingV1::RemoveDnsZoneRequest] remove_dns_zone_request_object
|
691
672
|
# @param [String] fields
|
692
673
|
# Selector specifying which fields to include in a partial response.
|
@@ -718,14 +699,13 @@ module Google
|
|
718
699
|
end
|
719
700
|
|
720
701
|
# Service producers can use this method to add roles in the shared VPC host
|
721
|
-
# project. Each role is bound to the provided member. Each role must be
|
722
|
-
#
|
723
|
-
#
|
702
|
+
# project. Each role is bound to the provided member. Each role must be selected
|
703
|
+
# from within a whitelisted set of roles. Each role is applied at only the
|
704
|
+
# granularity specified in the whitelist.
|
724
705
|
# @param [String] parent
|
725
706
|
# Required. This is in a form services/`service` where `service` is the name of
|
726
|
-
# the
|
727
|
-
#
|
728
|
-
# 'service-peering.example.com'.
|
707
|
+
# the private access management service. For example 'service-peering.example.
|
708
|
+
# com'.
|
729
709
|
# @param [Google::Apis::ServicenetworkingV1::AddRolesRequest] add_roles_request_object
|
730
710
|
# @param [String] fields
|
731
711
|
# Selector specifying which fields to include in a partial response.
|
@@ -26,7 +26,7 @@ module Google
|
|
26
26
|
# @see https://cloud.google.com/service-infrastructure/docs/service-networking/getting-started
|
27
27
|
module ServicenetworkingV1beta
|
28
28
|
VERSION = 'V1beta'
|
29
|
-
REVISION = '
|
29
|
+
REVISION = '20200801'
|
30
30
|
|
31
31
|
# View and manage your data across Google Cloud Platform services
|
32
32
|
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
|
@@ -114,21 +114,20 @@ module Google
|
|
114
114
|
class AddSubnetworkRequest
|
115
115
|
include Google::Apis::Core::Hashable
|
116
116
|
|
117
|
-
# Required. A resource that represents the service consumer, such as
|
118
|
-
#
|
119
|
-
#
|
120
|
-
#
|
121
|
-
#
|
117
|
+
# Required. A resource that represents the service consumer, such as `projects/
|
118
|
+
# 123456`. The project number can be different from the value in the consumer
|
119
|
+
# network parameter. For example, the network might be part of a Shared VPC
|
120
|
+
# network. In those cases, Service Networking validates that this resource
|
121
|
+
# belongs to that Shared VPC.
|
122
122
|
# Corresponds to the JSON property `consumer`
|
123
123
|
# @return [String]
|
124
124
|
attr_accessor :consumer
|
125
125
|
|
126
|
-
# Required. The name of the service consumer's VPC network. The network
|
127
|
-
#
|
128
|
-
# connections.create method. The name must be in the following format:
|
129
|
-
# `
|
130
|
-
#
|
131
|
-
# VPC network in the project.
|
126
|
+
# Required. The name of the service consumer's VPC network. The network must
|
127
|
+
# have an existing private connection that was provisioned through the
|
128
|
+
# connections.create method. The name must be in the following format: `projects/
|
129
|
+
# `project`/global/networks/`network``, where `project` is a project number,
|
130
|
+
# such as `12345`. `network` is the name of a VPC network in the project.
|
132
131
|
# Corresponds to the JSON property `consumerNetwork`
|
133
132
|
# @return [String]
|
134
133
|
attr_accessor :consumer_network
|
@@ -138,38 +137,38 @@ module Google
|
|
138
137
|
# @return [String]
|
139
138
|
attr_accessor :description
|
140
139
|
|
141
|
-
# Required. The prefix length of the subnet's IP address range.
|
142
|
-
#
|
143
|
-
#
|
144
|
-
#
|
140
|
+
# Required. The prefix length of the subnet's IP address range. Use CIDR range
|
141
|
+
# notation, such as `30` to provision a subnet with an `x.x.x.x/30` CIDR range.
|
142
|
+
# The IP address range is drawn from a pool of available ranges in the service
|
143
|
+
# consumer's allocated range.
|
145
144
|
# Corresponds to the JSON property `ipPrefixLength`
|
146
145
|
# @return [Fixnum]
|
147
146
|
attr_accessor :ip_prefix_length
|
148
147
|
|
149
|
-
# Required. The name of a [region](/compute/docs/regions-zones)
|
150
|
-
#
|
148
|
+
# Required. The name of a [region](/compute/docs/regions-zones) for the subnet,
|
149
|
+
# such `europe-west1`.
|
151
150
|
# Corresponds to the JSON property `region`
|
152
151
|
# @return [String]
|
153
152
|
attr_accessor :region
|
154
153
|
|
155
|
-
# Optional. The starting address of a range. The address must be a valid
|
156
|
-
#
|
157
|
-
#
|
158
|
-
#
|
159
|
-
#
|
154
|
+
# Optional. The starting address of a range. The address must be a valid IPv4
|
155
|
+
# address in the x.x.x.x format. This value combined with the IP prefix range is
|
156
|
+
# the CIDR range for the subnet. The range must be within the allocated range
|
157
|
+
# that is assigned to the private connection. If the CIDR range isn't available,
|
158
|
+
# the call fails.
|
160
159
|
# Corresponds to the JSON property `requestedAddress`
|
161
160
|
# @return [String]
|
162
161
|
attr_accessor :requested_address
|
163
162
|
|
164
163
|
# Required. A name for the new subnet. For information about the naming
|
165
|
-
# requirements, see [subnetwork](/compute/docs/reference/rest/v1/subnetworks)
|
166
|
-
#
|
164
|
+
# requirements, see [subnetwork](/compute/docs/reference/rest/v1/subnetworks) in
|
165
|
+
# the Compute API documentation.
|
167
166
|
# Corresponds to the JSON property `subnetwork`
|
168
167
|
# @return [String]
|
169
168
|
attr_accessor :subnetwork
|
170
169
|
|
171
|
-
# A list of members that are granted the `compute.networkUser`
|
172
|
-
#
|
170
|
+
# A list of members that are granted the `compute.networkUser` role on the
|
171
|
+
# subnet.
|
173
172
|
# Corresponds to the JSON property `subnetworkUsers`
|
174
173
|
# @return [Array<String>]
|
175
174
|
attr_accessor :subnetwork_users
|
@@ -191,14 +190,13 @@ module Google
|
|
191
190
|
end
|
192
191
|
end
|
193
192
|
|
194
|
-
# Api is a light-weight descriptor for an API Interface.
|
195
|
-
#
|
196
|
-
#
|
197
|
-
#
|
198
|
-
#
|
199
|
-
#
|
200
|
-
#
|
201
|
-
# detailed terminology.
|
193
|
+
# Api is a light-weight descriptor for an API Interface. Interfaces are also
|
194
|
+
# described as "protocol buffer services" in some contexts, such as by the "
|
195
|
+
# service" keyword in a .proto file, but they are different from API Services,
|
196
|
+
# which represent a concrete implementation of an interface as opposed to simply
|
197
|
+
# a description of methods and bindings. They are also sometimes simply referred
|
198
|
+
# to as "APIs" in other contexts, such as the name of this message itself. See
|
199
|
+
# https://cloud.google.com/apis/design/glossary for detailed terminology.
|
202
200
|
class Api
|
203
201
|
include Google::Apis::Core::Hashable
|
204
202
|
|
@@ -212,8 +210,8 @@ module Google
|
|
212
210
|
# @return [Array<Google::Apis::ServicenetworkingV1beta::Mixin>]
|
213
211
|
attr_accessor :mixins
|
214
212
|
|
215
|
-
# The fully qualified name of this interface, including package name
|
216
|
-
#
|
213
|
+
# The fully qualified name of this interface, including package name followed by
|
214
|
+
# the interface's simple name.
|
217
215
|
# Corresponds to the JSON property `name`
|
218
216
|
# @return [String]
|
219
217
|
attr_accessor :name
|
@@ -223,8 +221,8 @@ module Google
|
|
223
221
|
# @return [Array<Google::Apis::ServicenetworkingV1beta::Option>]
|
224
222
|
attr_accessor :options
|
225
223
|
|
226
|
-
# `SourceContext` represents information about the source of a
|
227
|
-
#
|
224
|
+
# `SourceContext` represents information about the source of a protobuf element,
|
225
|
+
# like the file in which it is defined.
|
228
226
|
# Corresponds to the JSON property `sourceContext`
|
229
227
|
# @return [Google::Apis::ServicenetworkingV1beta::SourceContext]
|
230
228
|
attr_accessor :source_context
|
@@ -234,23 +232,19 @@ module Google
|
|
234
232
|
# @return [String]
|
235
233
|
attr_accessor :syntax
|
236
234
|
|
237
|
-
# A version string for this interface. If specified, must have the form
|
238
|
-
#
|
239
|
-
#
|
240
|
-
#
|
241
|
-
#
|
242
|
-
#
|
243
|
-
#
|
244
|
-
#
|
245
|
-
#
|
246
|
-
#
|
247
|
-
#
|
248
|
-
#
|
249
|
-
#
|
250
|
-
# interface, which must end in `v<major-version>`, as in
|
251
|
-
# `google.feature.v1`. For major versions 0 and 1, the suffix can
|
252
|
-
# be omitted. Zero major versions must only be used for
|
253
|
-
# experimental, non-GA interfaces.
|
235
|
+
# A version string for this interface. If specified, must have the form `major-
|
236
|
+
# version.minor-version`, as in `1.10`. If the minor version is omitted, it
|
237
|
+
# defaults to zero. If the entire version field is empty, the major version is
|
238
|
+
# derived from the package name, as outlined below. If the field is not empty,
|
239
|
+
# the version in the package name will be verified to be consistent with what is
|
240
|
+
# provided here. The versioning schema uses [semantic versioning](http://semver.
|
241
|
+
# org) where the major version number indicates a breaking change and the minor
|
242
|
+
# version an additive, non-breaking change. Both version numbers are signals to
|
243
|
+
# users what to expect from different versions, and should be carefully chosen
|
244
|
+
# based on the product plan. The major version is also reflected in the package
|
245
|
+
# name of the interface, which must end in `v`, as in `google.feature.v1`. For
|
246
|
+
# major versions 0 and 1, the suffix can be omitted. Zero major versions must
|
247
|
+
# only be used for experimental, non-GA interfaces.
|
254
248
|
# Corresponds to the JSON property `version`
|
255
249
|
# @return [String]
|
256
250
|
attr_accessor :version
|
@@ -271,85 +265,63 @@ module Google
|
|
271
265
|
end
|
272
266
|
end
|
273
267
|
|
274
|
-
# Configuration for an authentication provider, including support for
|
275
|
-
#
|
276
|
-
# (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).
|
268
|
+
# Configuration for an authentication provider, including support for [JSON Web
|
269
|
+
# Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).
|
277
270
|
class AuthProvider
|
278
271
|
include Google::Apis::Core::Hashable
|
279
272
|
|
280
|
-
# The list of JWT
|
281
|
-
#
|
282
|
-
#
|
283
|
-
#
|
284
|
-
# be accepted.
|
285
|
-
# -
|
286
|
-
# - "https://[service.name]/"
|
287
|
-
# will be accepted.
|
288
|
-
# For example, if no audiences are in the setting, LibraryService API will
|
289
|
-
# accept JWTs with the following audiences:
|
290
|
-
# -
|
273
|
+
# The list of JWT [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-
|
274
|
+
# web-token-32#section-4.1.3). that are allowed to access. A JWT containing any
|
275
|
+
# of these audiences will be accepted. When this setting is absent, JWTs with
|
276
|
+
# audiences: - "https://[service.name]/[google.protobuf.Api.name]" - "https://[
|
277
|
+
# service.name]/" will be accepted. For example, if no audiences are in the
|
278
|
+
# setting, LibraryService API will accept JWTs with the following audiences: -
|
291
279
|
# https://library-example.googleapis.com/google.example.library.v1.
|
292
|
-
# LibraryService
|
293
|
-
#
|
294
|
-
#
|
295
|
-
# audiences: bookstore_android.apps.googleusercontent.com,
|
296
|
-
# bookstore_web.apps.googleusercontent.com
|
280
|
+
# LibraryService - https://library-example.googleapis.com/ Example: audiences:
|
281
|
+
# bookstore_android.apps.googleusercontent.com, bookstore_web.apps.
|
282
|
+
# googleusercontent.com
|
297
283
|
# Corresponds to the JSON property `audiences`
|
298
284
|
# @return [String]
|
299
285
|
attr_accessor :audiences
|
300
286
|
|
301
|
-
# Redirect URL if JWT token is required but not present or is expired.
|
302
|
-
#
|
287
|
+
# Redirect URL if JWT token is required but not present or is expired. Implement
|
288
|
+
# authorizationUrl of securityDefinitions in OpenAPI spec.
|
303
289
|
# Corresponds to the JSON property `authorizationUrl`
|
304
290
|
# @return [String]
|
305
291
|
attr_accessor :authorization_url
|
306
292
|
|
307
|
-
# The unique identifier of the auth provider. It will be referred to by
|
308
|
-
#
|
309
|
-
# Example: "bookstore_auth".
|
293
|
+
# The unique identifier of the auth provider. It will be referred to by `
|
294
|
+
# AuthRequirement.provider_id`. Example: "bookstore_auth".
|
310
295
|
# Corresponds to the JSON property `id`
|
311
296
|
# @return [String]
|
312
297
|
attr_accessor :id
|
313
298
|
|
314
|
-
# Identifies the principal that issued the JWT. See
|
315
|
-
#
|
316
|
-
#
|
317
|
-
#
|
318
|
-
# Example: 1234567-compute@developer.gserviceaccount.com
|
299
|
+
# Identifies the principal that issued the JWT. See https://tools.ietf.org/html/
|
300
|
+
# draft-ietf-oauth-json-web-token-32#section-4.1.1 Usually a URL or an email
|
301
|
+
# address. Example: https://securetoken.google.com Example: 1234567-compute@
|
302
|
+
# developer.gserviceaccount.com
|
319
303
|
# Corresponds to the JSON property `issuer`
|
320
304
|
# @return [String]
|
321
305
|
attr_accessor :issuer
|
322
306
|
|
323
|
-
# URL of the provider's public key set to validate signature of the JWT. See
|
324
|
-
#
|
325
|
-
#
|
326
|
-
#
|
327
|
-
#
|
328
|
-
#
|
329
|
-
# [OpenID
|
330
|
-
# Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html of
|
331
|
-
# the issuer.
|
332
|
-
# - can be inferred from the email domain of the issuer (e.g. a Google
|
333
|
-
# service account).
|
334
|
-
# Example: https://www.googleapis.com/oauth2/v1/certs
|
307
|
+
# URL of the provider's public key set to validate signature of the JWT. See [
|
308
|
+
# OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#
|
309
|
+
# ProviderMetadata). Optional if the key set document: - can be retrieved from [
|
310
|
+
# OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html
|
311
|
+
# of the issuer. - can be inferred from the email domain of the issuer (e.g. a
|
312
|
+
# Google service account). Example: https://www.googleapis.com/oauth2/v1/certs
|
335
313
|
# Corresponds to the JSON property `jwksUri`
|
336
314
|
# @return [String]
|
337
315
|
attr_accessor :jwks_uri
|
338
316
|
|
339
|
-
# Defines the locations to extract the JWT.
|
340
|
-
#
|
341
|
-
# The
|
342
|
-
#
|
343
|
-
#
|
344
|
-
#
|
345
|
-
#
|
346
|
-
#
|
347
|
-
# Default locations can be specified as followings:
|
348
|
-
# jwt_locations:
|
349
|
-
# - header: Authorization
|
350
|
-
# value_prefix: "Bearer "
|
351
|
-
# - header: x-goog-iap-jwt-assertion
|
352
|
-
# - query: access_token
|
317
|
+
# Defines the locations to extract the JWT. JWT locations can be either from
|
318
|
+
# HTTP headers or URL query parameters. The rule is that the first match wins.
|
319
|
+
# The checking order is: checking all headers first, then URL query parameters.
|
320
|
+
# If not specified, default to use following 3 locations: 1) Authorization:
|
321
|
+
# Bearer 2) x-goog-iap-jwt-assertion 3) access_token query parameter Default
|
322
|
+
# locations can be specified as followings: jwt_locations: - header:
|
323
|
+
# Authorization value_prefix: "Bearer " - header: x-goog-iap-jwt-assertion -
|
324
|
+
# query: access_token
|
353
325
|
# Corresponds to the JSON property `jwtLocations`
|
354
326
|
# @return [Array<Google::Apis::ServicenetworkingV1beta::JwtLocation>]
|
355
327
|
attr_accessor :jwt_locations
|
@@ -369,34 +341,26 @@ module Google
|
|
369
341
|
end
|
370
342
|
end
|
371
343
|
|
372
|
-
# User-defined authentication requirements, including support for
|
373
|
-
#
|
374
|
-
# (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).
|
344
|
+
# User-defined authentication requirements, including support for [JSON Web
|
345
|
+
# Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).
|
375
346
|
class AuthRequirement
|
376
347
|
include Google::Apis::Core::Hashable
|
377
348
|
|
378
|
-
# NOTE: This will be deprecated soon, once AuthProvider.audiences is
|
379
|
-
#
|
380
|
-
#
|
381
|
-
#
|
382
|
-
#
|
383
|
-
#
|
384
|
-
#
|
385
|
-
# "https://
|
386
|
-
#
|
387
|
-
#
|
388
|
-
# "https://library-example.googleapis.com/google.example.library.v1.
|
389
|
-
# LibraryService".
|
390
|
-
# Example:
|
391
|
-
# audiences: bookstore_android.apps.googleusercontent.com,
|
392
|
-
# bookstore_web.apps.googleusercontent.com
|
349
|
+
# NOTE: This will be deprecated soon, once AuthProvider.audiences is implemented
|
350
|
+
# and accepted in all the runtime components. The list of JWT [audiences](https:/
|
351
|
+
# /tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). that
|
352
|
+
# are allowed to access. A JWT containing any of these audiences will be
|
353
|
+
# accepted. When this setting is absent, only JWTs with audience "https://
|
354
|
+
# Service_name/API_name" will be accepted. For example, if no audiences are in
|
355
|
+
# the setting, LibraryService API will only accept JWTs with the following
|
356
|
+
# audience "https://library-example.googleapis.com/google.example.library.v1.
|
357
|
+
# LibraryService". Example: audiences: bookstore_android.apps.googleusercontent.
|
358
|
+
# com, bookstore_web.apps.googleusercontent.com
|
393
359
|
# Corresponds to the JSON property `audiences`
|
394
360
|
# @return [String]
|
395
361
|
attr_accessor :audiences
|
396
362
|
|
397
|
-
# id from authentication provider.
|
398
|
-
# Example:
|
399
|
-
# provider_id: bookstore_auth
|
363
|
+
# id from authentication provider. Example: provider_id: bookstore_auth
|
400
364
|
# Corresponds to the JSON property `providerId`
|
401
365
|
# @return [String]
|
402
366
|
attr_accessor :provider_id
|
@@ -412,18 +376,11 @@ module Google
|
|
412
376
|
end
|
413
377
|
end
|
414
378
|
|
415
|
-
# `Authentication` defines the authentication configuration for an API.
|
416
|
-
#
|
417
|
-
#
|
418
|
-
#
|
419
|
-
#
|
420
|
-
# - id: google_calendar_auth
|
421
|
-
# jwks_uri: https://www.googleapis.com/oauth2/v1/certs
|
422
|
-
# issuer: https://securetoken.google.com
|
423
|
-
# rules:
|
424
|
-
# - selector: "*"
|
425
|
-
# requirements:
|
426
|
-
# provider_id: google_calendar_auth
|
379
|
+
# `Authentication` defines the authentication configuration for an API. Example
|
380
|
+
# for an API targeted for external use: name: calendar.googleapis.com
|
381
|
+
# authentication: providers: - id: google_calendar_auth jwks_uri: https://www.
|
382
|
+
# googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: -
|
383
|
+
# selector: "*" requirements: provider_id: google_calendar_auth
|
427
384
|
class Authentication
|
428
385
|
include Google::Apis::Core::Hashable
|
429
386
|
|
@@ -432,8 +389,8 @@ module Google
|
|
432
389
|
# @return [Array<Google::Apis::ServicenetworkingV1beta::AuthProvider>]
|
433
390
|
attr_accessor :providers
|
434
391
|
|
435
|
-
# A list of authentication rules that apply to individual API methods.
|
436
|
-
#
|
392
|
+
# A list of authentication rules that apply to individual API methods. **NOTE:**
|
393
|
+
# All service configuration rules follow "last one wins" order.
|
437
394
|
# Corresponds to the JSON property `rules`
|
438
395
|
# @return [Array<Google::Apis::ServicenetworkingV1beta::AuthenticationRule>]
|
439
396
|
attr_accessor :rules
|
@@ -449,13 +406,11 @@ module Google
|
|
449
406
|
end
|
450
407
|
end
|
451
408
|
|
452
|
-
# Authentication rules for the service.
|
453
|
-
#
|
454
|
-
#
|
455
|
-
#
|
456
|
-
# request.
|
457
|
-
# If a method doesn't have any auth requirements, request credentials will be
|
458
|
-
# ignored.
|
409
|
+
# Authentication rules for the service. By default, if a method has any
|
410
|
+
# authentication requirements, every request must include a valid credential
|
411
|
+
# matching one of the requirements. It's an error to include more than one kind
|
412
|
+
# of credential in a single request. If a method doesn't have any auth
|
413
|
+
# requirements, request credentials will be ignored.
|
459
414
|
class AuthenticationRule
|
460
415
|
include Google::Apis::Core::Hashable
|
461
416
|
|
@@ -466,19 +421,18 @@ module Google
|
|
466
421
|
alias_method :allow_without_credential?, :allow_without_credential
|
467
422
|
|
468
423
|
# OAuth scopes are a way to define data and permissions on data. For example,
|
469
|
-
# there are scopes defined for "Read-only access to Google Calendar" and
|
470
|
-
#
|
471
|
-
#
|
472
|
-
#
|
473
|
-
#
|
474
|
-
#
|
475
|
-
#
|
476
|
-
#
|
477
|
-
#
|
478
|
-
#
|
479
|
-
#
|
480
|
-
#
|
481
|
-
# due to the backend requiring additional scopes or permissions.
|
424
|
+
# there are scopes defined for "Read-only access to Google Calendar" and "Access
|
425
|
+
# to Cloud Platform". Users can consent to a scope for an application, giving it
|
426
|
+
# permission to access that data on their behalf. OAuth scope specifications
|
427
|
+
# should be fairly coarse grained; a user will need to see and understand the
|
428
|
+
# text description of what your scope means. In most cases: use one or at most
|
429
|
+
# two OAuth scopes for an entire family of products. If your product has
|
430
|
+
# multiple APIs, you should probably be sharing the OAuth scope across all of
|
431
|
+
# those APIs. When you need finer grained OAuth consent screens: talk with your
|
432
|
+
# product management about how developers will use them in practice. Please note
|
433
|
+
# that even though each of the canonical scopes is enough for a request to be
|
434
|
+
# accepted and passed to the backend, a request can still fail due to the
|
435
|
+
# backend requiring additional scopes or permissions.
|
482
436
|
# Corresponds to the JSON property `oauth`
|
483
437
|
# @return [Google::Apis::ServicenetworkingV1beta::OAuthRequirements]
|
484
438
|
attr_accessor :oauth
|
@@ -488,8 +442,8 @@ module Google
|
|
488
442
|
# @return [Array<Google::Apis::ServicenetworkingV1beta::AuthRequirement>]
|
489
443
|
attr_accessor :requirements
|
490
444
|
|
491
|
-
# Selects the methods to which this rule applies.
|
492
|
-
#
|
445
|
+
# Selects the methods to which this rule applies. Refer to selector for syntax
|
446
|
+
# details.
|
493
447
|
# Corresponds to the JSON property `selector`
|
494
448
|
# @return [String]
|
495
449
|
attr_accessor :selector
|
@@ -511,8 +465,8 @@ module Google
|
|
511
465
|
class Backend
|
512
466
|
include Google::Apis::Core::Hashable
|
513
467
|
|
514
|
-
# A list of API backend rules that apply to individual API methods.
|
515
|
-
#
|
468
|
+
# A list of API backend rules that apply to individual API methods. **NOTE:**
|
469
|
+
# All service configuration rules follow "last one wins" order.
|
516
470
|
# Corresponds to the JSON property `rules`
|
517
471
|
# @return [Array<Google::Apis::ServicenetworkingV1beta::BackendRule>]
|
518
472
|
attr_accessor :rules
|
@@ -531,21 +485,13 @@ module Google
|
|
531
485
|
class BackendRule
|
532
486
|
include Google::Apis::Core::Hashable
|
533
487
|
|
534
|
-
# The address of the API backend.
|
535
|
-
#
|
536
|
-
#
|
537
|
-
#
|
538
|
-
#
|
539
|
-
#
|
540
|
-
#
|
541
|
-
# grpcs:// gRPC TLS
|
542
|
-
# It is recommended to explicitly include a scheme. Leaving out the scheme
|
543
|
-
# may cause constrasting behaviors across platforms.
|
544
|
-
# If the port is unspecified, the default is:
|
545
|
-
# - 80 for schemes without TLS
|
546
|
-
# - 443 for schemes with TLS
|
547
|
-
# For HTTP backends, use protocol
|
548
|
-
# to specify the protocol version.
|
488
|
+
# The address of the API backend. The scheme is used to determine the backend
|
489
|
+
# protocol and security. The following schemes are accepted: SCHEME PROTOCOL
|
490
|
+
# SECURITY http:// HTTP None https:// HTTP TLS grpc:// gRPC None grpcs:// gRPC
|
491
|
+
# TLS It is recommended to explicitly include a scheme. Leaving out the scheme
|
492
|
+
# may cause constrasting behaviors across platforms. If the port is unspecified,
|
493
|
+
# the default is: - 80 for schemes without TLS - 443 for schemes with TLS For
|
494
|
+
# HTTP backends, use protocol to specify the protocol version.
|
549
495
|
# Corresponds to the JSON property `address`
|
550
496
|
# @return [String]
|
551
497
|
attr_accessor :address
|
@@ -556,18 +502,18 @@ module Google
|
|
556
502
|
# @return [Float]
|
557
503
|
attr_accessor :deadline
|
558
504
|
|
559
|
-
# When disable_auth is true, a JWT ID token won't be generated and the
|
560
|
-
#
|
561
|
-
#
|
562
|
-
#
|
505
|
+
# When disable_auth is true, a JWT ID token won't be generated and the original "
|
506
|
+
# Authorization" HTTP header will be preserved. If the header is used to carry
|
507
|
+
# the original token and is expected by the backend, this field must be set to
|
508
|
+
# true to preserve the header.
|
563
509
|
# Corresponds to the JSON property `disableAuth`
|
564
510
|
# @return [Boolean]
|
565
511
|
attr_accessor :disable_auth
|
566
512
|
alias_method :disable_auth?, :disable_auth
|
567
513
|
|
568
|
-
# The JWT audience is used when generating a JWT ID token for the backend.
|
569
|
-
#
|
570
|
-
#
|
514
|
+
# The JWT audience is used when generating a JWT ID token for the backend. This
|
515
|
+
# ID token will be added in the HTTP "authorization" header, and sent to the
|
516
|
+
# backend.
|
571
517
|
# Corresponds to the JSON property `jwtAudience`
|
572
518
|
# @return [String]
|
573
519
|
attr_accessor :jwt_audience
|
@@ -578,8 +524,8 @@ module Google
|
|
578
524
|
# @return [Float]
|
579
525
|
attr_accessor :min_deadline
|
580
526
|
|
581
|
-
# The number of seconds to wait for the completion of a long running
|
582
|
-
#
|
527
|
+
# The number of seconds to wait for the completion of a long running operation.
|
528
|
+
# The default is no deadline.
|
583
529
|
# Corresponds to the JSON property `operationDeadline`
|
584
530
|
# @return [Float]
|
585
531
|
attr_accessor :operation_deadline
|
@@ -589,29 +535,21 @@ module Google
|
|
589
535
|
# @return [String]
|
590
536
|
attr_accessor :path_translation
|
591
537
|
|
592
|
-
# The protocol used for sending a request to the backend.
|
593
|
-
#
|
594
|
-
#
|
595
|
-
#
|
596
|
-
#
|
597
|
-
#
|
598
|
-
# https://
|
599
|
-
#
|
600
|
-
#
|
601
|
-
# For secure HTTP backends (https://) that support HTTP/2, set this field
|
602
|
-
# to "h2" for improved performance.
|
603
|
-
# Configuring this field to non-default values is only supported for secure
|
604
|
-
# HTTP backends. This field will be ignored for all other backends.
|
605
|
-
# See
|
606
|
-
# https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-
|
607
|
-
# values.xhtml#alpn-protocol-ids
|
608
|
-
# for more details on the supported values.
|
538
|
+
# The protocol used for sending a request to the backend. The supported values
|
539
|
+
# are "http/1.1" and "h2". The default value is inferred from the scheme in the
|
540
|
+
# address field: SCHEME PROTOCOL http:// http/1.1 https:// http/1.1 grpc:// h2
|
541
|
+
# grpcs:// h2 For secure HTTP backends (https://) that support HTTP/2, set this
|
542
|
+
# field to "h2" for improved performance. Configuring this field to non-default
|
543
|
+
# values is only supported for secure HTTP backends. This field will be ignored
|
544
|
+
# for all other backends. See https://www.iana.org/assignments/tls-extensiontype-
|
545
|
+
# values/tls-extensiontype-values.xhtml#alpn-protocol-ids for more details on
|
546
|
+
# the supported values.
|
609
547
|
# Corresponds to the JSON property `protocol`
|
610
548
|
# @return [String]
|
611
549
|
attr_accessor :protocol
|
612
550
|
|
613
|
-
# Selects the methods to which this rule applies.
|
614
|
-
#
|
551
|
+
# Selects the methods to which this rule applies. Refer to selector for syntax
|
552
|
+
# details.
|
615
553
|
# Corresponds to the JSON property `selector`
|
616
554
|
# @return [String]
|
617
555
|
attr_accessor :selector
|
@@ -634,42 +572,28 @@ module Google
|
|
634
572
|
end
|
635
573
|
end
|
636
574
|
|
637
|
-
# Billing related configuration of the service.
|
638
|
-
#
|
639
|
-
#
|
640
|
-
#
|
641
|
-
#
|
642
|
-
#
|
643
|
-
#
|
644
|
-
#
|
645
|
-
# -
|
646
|
-
#
|
647
|
-
# - key:
|
648
|
-
#
|
649
|
-
#
|
650
|
-
# -
|
651
|
-
#
|
652
|
-
# Custom label to define the city where the library branch is located
|
653
|
-
# in.
|
654
|
-
# - key: name
|
655
|
-
# description: Custom label to define the name of the library branch.
|
656
|
-
# metrics:
|
657
|
-
# - name: library.googleapis.com/book/borrowed_count
|
658
|
-
# metric_kind: DELTA
|
659
|
-
# value_type: INT64
|
660
|
-
# unit: "1"
|
661
|
-
# billing:
|
662
|
-
# consumer_destinations:
|
663
|
-
# - monitored_resource: library.googleapis.com/billing_branch
|
664
|
-
# metrics:
|
665
|
-
# - library.googleapis.com/book/borrowed_count
|
575
|
+
# Billing related configuration of the service. The following example shows how
|
576
|
+
# to configure monitored resources and metrics for billing, `
|
577
|
+
# consumer_destinations` is the only supported destination and the monitored
|
578
|
+
# resources need at least one label key `cloud.googleapis.com/location` to
|
579
|
+
# indicate the location of the billing usage, using different monitored
|
580
|
+
# resources between monitoring and billing is recommended so they can be evolved
|
581
|
+
# independently: monitored_resources: - type: library.googleapis.com/
|
582
|
+
# billing_branch labels: - key: cloud.googleapis.com/location description: |
|
583
|
+
# Predefined label to support billing location restriction. - key: city
|
584
|
+
# description: | Custom label to define the city where the library branch is
|
585
|
+
# located in. - key: name description: Custom label to define the name of the
|
586
|
+
# library branch. metrics: - name: library.googleapis.com/book/borrowed_count
|
587
|
+
# metric_kind: DELTA value_type: INT64 unit: "1" billing: consumer_destinations:
|
588
|
+
# - monitored_resource: library.googleapis.com/billing_branch metrics: - library.
|
589
|
+
# googleapis.com/book/borrowed_count
|
666
590
|
class Billing
|
667
591
|
include Google::Apis::Core::Hashable
|
668
592
|
|
669
|
-
# Billing configurations for sending metrics to the consumer project.
|
670
|
-
#
|
671
|
-
#
|
672
|
-
#
|
593
|
+
# Billing configurations for sending metrics to the consumer project. There can
|
594
|
+
# be multiple consumer destinations per service, each one must have a different
|
595
|
+
# monitored resource type. A metric can be used in at most one consumer
|
596
|
+
# destination.
|
673
597
|
# Corresponds to the JSON property `consumerDestinations`
|
674
598
|
# @return [Array<Google::Apis::ServicenetworkingV1beta::BillingDestination>]
|
675
599
|
attr_accessor :consumer_destinations
|
@@ -684,19 +608,19 @@ module Google
|
|
684
608
|
end
|
685
609
|
end
|
686
610
|
|
687
|
-
# Configuration of a specific billing destination (Currently only support
|
688
|
-
#
|
611
|
+
# Configuration of a specific billing destination (Currently only support bill
|
612
|
+
# against consumer project).
|
689
613
|
class BillingDestination
|
690
614
|
include Google::Apis::Core::Hashable
|
691
615
|
|
692
|
-
# Names of the metrics to report to this billing destination.
|
693
|
-
#
|
616
|
+
# Names of the metrics to report to this billing destination. Each name must be
|
617
|
+
# defined in Service.metrics section.
|
694
618
|
# Corresponds to the JSON property `metrics`
|
695
619
|
# @return [Array<String>]
|
696
620
|
attr_accessor :metrics
|
697
621
|
|
698
|
-
# The monitored resource type. The type must be defined in
|
699
|
-
#
|
622
|
+
# The monitored resource type. The type must be defined in Service.
|
623
|
+
# monitored_resources section.
|
700
624
|
# Corresponds to the JSON property `monitoredResource`
|
701
625
|
# @return [String]
|
702
626
|
attr_accessor :monitored_resource
|
@@ -719,34 +643,30 @@ module Google
|
|
719
643
|
include Google::Apis::Core::Hashable
|
720
644
|
|
721
645
|
# The name of service consumer's VPC network that's connected with service
|
722
|
-
# producer network, in the following format:
|
723
|
-
# `
|
724
|
-
#
|
725
|
-
#
|
726
|
-
# service consumer's VPC network.
|
646
|
+
# producer network, in the following format: `projects/`project`/global/networks/
|
647
|
+
# `network``. ``project`` is a project number, such as in `12345` that includes
|
648
|
+
# the VPC service consumer's VPC network. ``network`` is the name of the service
|
649
|
+
# consumer's VPC network.
|
727
650
|
# Corresponds to the JSON property `network`
|
728
651
|
# @return [String]
|
729
652
|
attr_accessor :network
|
730
653
|
|
731
654
|
# Output only. The name of the VPC Network Peering connection that was created
|
732
|
-
# by the
|
733
|
-
# service producer.
|
655
|
+
# by the service producer.
|
734
656
|
# Corresponds to the JSON property `peering`
|
735
657
|
# @return [String]
|
736
658
|
attr_accessor :peering
|
737
659
|
|
738
|
-
# The name of one or more allocated IP address ranges for this service
|
739
|
-
#
|
740
|
-
#
|
741
|
-
# already established will not modify already provisioned service
|
660
|
+
# The name of one or more allocated IP address ranges for this service producer
|
661
|
+
# of type `PEERING`. Note that invoking this method with a different range when
|
662
|
+
# connection is already established will not modify already provisioned service
|
742
663
|
# producer subnetworks.
|
743
664
|
# Corresponds to the JSON property `reservedPeeringRanges`
|
744
665
|
# @return [Array<String>]
|
745
666
|
attr_accessor :reserved_peering_ranges
|
746
667
|
|
747
668
|
# Output only. The name of the peering service that's associated with this
|
748
|
-
# connection, in
|
749
|
-
# the following format: `services/`service name``.
|
669
|
+
# connection, in the following format: `services/`service name``.
|
750
670
|
# Corresponds to the JSON property `service`
|
751
671
|
# @return [String]
|
752
672
|
attr_accessor :service
|
@@ -764,39 +684,24 @@ module Google
|
|
764
684
|
end
|
765
685
|
end
|
766
686
|
|
767
|
-
# `Context` defines which contexts an API requests.
|
768
|
-
#
|
769
|
-
# context
|
770
|
-
#
|
771
|
-
#
|
772
|
-
#
|
773
|
-
# -
|
774
|
-
#
|
775
|
-
#
|
776
|
-
#
|
777
|
-
#
|
778
|
-
#
|
779
|
-
#
|
780
|
-
# This also provides mechanism to whitelist any protobuf message extension that
|
781
|
-
# can be sent in grpc metadata using “x-goog-ext-<extension_id>-bin” and
|
782
|
-
# “x-goog-ext-<extension_id>-jspb” format. For example, list any service
|
783
|
-
# specific protobuf types that can appear in grpc metadata as follows in your
|
784
|
-
# yaml file:
|
785
|
-
# Example:
|
786
|
-
# context:
|
787
|
-
# rules:
|
788
|
-
# - selector: "google.example.library.v1.LibraryService.CreateBook"
|
789
|
-
# allowed_request_extensions:
|
790
|
-
# - google.foo.v1.NewExtension
|
791
|
-
# allowed_response_extensions:
|
792
|
-
# - google.foo.v1.NewExtension
|
793
|
-
# You can also specify extension ID instead of fully qualified extension name
|
794
|
-
# here.
|
687
|
+
# `Context` defines which contexts an API requests. Example: context: rules: -
|
688
|
+
# selector: "*" requested: - google.rpc.context.ProjectContext - google.rpc.
|
689
|
+
# context.OriginContext The above specifies that all methods in the API request `
|
690
|
+
# google.rpc.context.ProjectContext` and `google.rpc.context.OriginContext`.
|
691
|
+
# Available context types are defined in package `google.rpc.context`. This also
|
692
|
+
# provides mechanism to whitelist any protobuf message extension that can be
|
693
|
+
# sent in grpc metadata using “x-goog-ext--bin” and “x-goog-ext--jspb” format.
|
694
|
+
# For example, list any service specific protobuf types that can appear in grpc
|
695
|
+
# metadata as follows in your yaml file: Example: context: rules: - selector: "
|
696
|
+
# google.example.library.v1.LibraryService.CreateBook"
|
697
|
+
# allowed_request_extensions: - google.foo.v1.NewExtension
|
698
|
+
# allowed_response_extensions: - google.foo.v1.NewExtension You can also specify
|
699
|
+
# extension ID instead of fully qualified extension name here.
|
795
700
|
class Context
|
796
701
|
include Google::Apis::Core::Hashable
|
797
702
|
|
798
|
-
# A list of RPC context rules that apply to individual API methods.
|
799
|
-
#
|
703
|
+
# A list of RPC context rules that apply to individual API methods. **NOTE:**
|
704
|
+
# All service configuration rules follow "last one wins" order.
|
800
705
|
# Corresponds to the JSON property `rules`
|
801
706
|
# @return [Array<Google::Apis::ServicenetworkingV1beta::ContextRule>]
|
802
707
|
attr_accessor :rules
|
@@ -816,14 +721,14 @@ module Google
|
|
816
721
|
class ContextRule
|
817
722
|
include Google::Apis::Core::Hashable
|
818
723
|
|
819
|
-
# A list of full type names or extension IDs of extensions allowed in grpc
|
820
|
-
#
|
724
|
+
# A list of full type names or extension IDs of extensions allowed in grpc side
|
725
|
+
# channel from client to backend.
|
821
726
|
# Corresponds to the JSON property `allowedRequestExtensions`
|
822
727
|
# @return [Array<String>]
|
823
728
|
attr_accessor :allowed_request_extensions
|
824
729
|
|
825
|
-
# A list of full type names or extension IDs of extensions allowed in grpc
|
826
|
-
#
|
730
|
+
# A list of full type names or extension IDs of extensions allowed in grpc side
|
731
|
+
# channel from backend to client.
|
827
732
|
# Corresponds to the JSON property `allowedResponseExtensions`
|
828
733
|
# @return [Array<String>]
|
829
734
|
attr_accessor :allowed_response_extensions
|
@@ -838,8 +743,8 @@ module Google
|
|
838
743
|
# @return [Array<String>]
|
839
744
|
attr_accessor :requested
|
840
745
|
|
841
|
-
# Selects the methods to which this rule applies.
|
842
|
-
#
|
746
|
+
# Selects the methods to which this rule applies. Refer to selector for syntax
|
747
|
+
# details.
|
843
748
|
# Corresponds to the JSON property `selector`
|
844
749
|
# @return [String]
|
845
750
|
attr_accessor :selector
|
@@ -858,14 +763,14 @@ module Google
|
|
858
763
|
end
|
859
764
|
end
|
860
765
|
|
861
|
-
# Selects and configures the service controller used by the service.
|
862
|
-
#
|
863
|
-
#
|
766
|
+
# Selects and configures the service controller used by the service. The service
|
767
|
+
# controller handles features like abuse, quota, billing, logging, monitoring,
|
768
|
+
# etc.
|
864
769
|
class Control
|
865
770
|
include Google::Apis::Core::Hashable
|
866
771
|
|
867
|
-
# The service control environment to use. If empty, no control plane
|
868
|
-
#
|
772
|
+
# The service control environment to use. If empty, no control plane feature (
|
773
|
+
# like quota and billing) will be enabled.
|
869
774
|
# Corresponds to the JSON property `environment`
|
870
775
|
# @return [String]
|
871
776
|
attr_accessor :environment
|
@@ -880,19 +785,15 @@ module Google
|
|
880
785
|
end
|
881
786
|
end
|
882
787
|
|
883
|
-
# Customize service error responses.
|
884
|
-
#
|
885
|
-
#
|
886
|
-
#
|
887
|
-
# custom_error:
|
888
|
-
# types:
|
889
|
-
# - google.foo.v1.CustomError
|
890
|
-
# - google.foo.v1.AnotherError
|
788
|
+
# Customize service error responses. For example, list any service specific
|
789
|
+
# protobuf types that can appear in error detail lists of error responses.
|
790
|
+
# Example: custom_error: types: - google.foo.v1.CustomError - google.foo.v1.
|
791
|
+
# AnotherError
|
891
792
|
class CustomError
|
892
793
|
include Google::Apis::Core::Hashable
|
893
794
|
|
894
|
-
# The list of custom error rules that apply to individual API messages.
|
895
|
-
#
|
795
|
+
# The list of custom error rules that apply to individual API messages. **NOTE:**
|
796
|
+
# All service configuration rules follow "last one wins" order.
|
896
797
|
# Corresponds to the JSON property `rules`
|
897
798
|
# @return [Array<Google::Apis::ServicenetworkingV1beta::CustomErrorRule>]
|
898
799
|
attr_accessor :rules
|
@@ -917,15 +818,15 @@ module Google
|
|
917
818
|
class CustomErrorRule
|
918
819
|
include Google::Apis::Core::Hashable
|
919
820
|
|
920
|
-
# Mark this message as possible payload in error response.
|
921
|
-
#
|
821
|
+
# Mark this message as possible payload in error response. Otherwise, objects of
|
822
|
+
# this type will be filtered when they appear in error payload.
|
922
823
|
# Corresponds to the JSON property `isErrorType`
|
923
824
|
# @return [Boolean]
|
924
825
|
attr_accessor :is_error_type
|
925
826
|
alias_method :is_error_type?, :is_error_type
|
926
827
|
|
927
|
-
# Selects messages to which this rule applies.
|
928
|
-
#
|
828
|
+
# Selects messages to which this rule applies. Refer to selector for syntax
|
829
|
+
# details.
|
929
830
|
# Corresponds to the JSON property `selector`
|
930
831
|
# @return [String]
|
931
832
|
attr_accessor :selector
|
@@ -1014,9 +915,9 @@ module Google
|
|
1014
915
|
# @return [String]
|
1015
916
|
attr_accessor :dns_suffix
|
1016
917
|
|
1017
|
-
# User assigned name for this resource. Must be unique within the project.
|
1018
|
-
#
|
1019
|
-
#
|
918
|
+
# User assigned name for this resource. Must be unique within the project. The
|
919
|
+
# name must be 1-63 characters long, must begin with a letter, end with a letter
|
920
|
+
# or digit, and only contain lowercase letters, digits or dashes.
|
1020
921
|
# Corresponds to the JSON property `name`
|
1021
922
|
# @return [String]
|
1022
923
|
attr_accessor :name
|
@@ -1032,56 +933,32 @@ module Google
|
|
1032
933
|
end
|
1033
934
|
end
|
1034
935
|
|
1035
|
-
# `Documentation` provides the information for describing a service.
|
1036
|
-
#
|
1037
|
-
#
|
1038
|
-
#
|
1039
|
-
#
|
1040
|
-
#
|
1041
|
-
#
|
1042
|
-
#
|
1043
|
-
#
|
1044
|
-
#
|
1045
|
-
#
|
1046
|
-
#
|
1047
|
-
#
|
1048
|
-
#
|
1049
|
-
#
|
1050
|
-
#
|
1051
|
-
#
|
1052
|
-
#
|
1053
|
-
#
|
1054
|
-
#
|
1055
|
-
#
|
1056
|
-
#
|
1057
|
-
#
|
1058
|
-
#
|
1059
|
-
#
|
1060
|
-
#
|
1061
|
-
# a documentation fragment is embedded.
|
1062
|
-
# Documentation from the IDL is merged with documentation defined
|
1063
|
-
# via the config at normalization time, where documentation provided
|
1064
|
-
# by config rules overrides IDL provided.
|
1065
|
-
# A number of constructs specific to the API platform are supported
|
1066
|
-
# in documentation text.
|
1067
|
-
# In order to reference a proto element, the following
|
1068
|
-
# notation can be used:
|
1069
|
-
# <pre><code>[fully.qualified.proto.name][]</code></pre>
|
1070
|
-
# To override the display text used for the link, this can be used:
|
1071
|
-
# <pre><code>[display text][fully.qualified.proto.name]</code></pre>
|
1072
|
-
# Text can be excluded from doc using the following notation:
|
1073
|
-
# <pre><code>(-- internal comment --)</code></pre>
|
1074
|
-
# A few directives are available in documentation. Note that
|
1075
|
-
# directives must appear on a single line to be properly
|
1076
|
-
# identified. The `include` directive includes a markdown file from
|
1077
|
-
# an external source:
|
1078
|
-
# <pre><code>(== include path/to/file ==)</code></pre>
|
1079
|
-
# The `resource_for` directive marks a message to be the resource of
|
1080
|
-
# a collection in REST view. If it is not specified, tools attempt
|
1081
|
-
# to infer the resource from the operations in a collection:
|
1082
|
-
# <pre><code>(== resource_for v1.shelves.books ==)</code></pre>
|
1083
|
-
# The directive `suppress_warning` does not directly affect documentation
|
1084
|
-
# and is documented together with service config validation.
|
936
|
+
# `Documentation` provides the information for describing a service. Example:
|
937
|
+
# documentation: summary: > The Google Calendar API gives access to most
|
938
|
+
# calendar features. pages: - name: Overview content: (== include google/foo/
|
939
|
+
# overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==
|
940
|
+
# ) subpages; - name: Java content: (== include google/foo/tutorial_java.md ==)
|
941
|
+
# rules: - selector: google.calendar.Calendar.Get description: > ... - selector:
|
942
|
+
# google.calendar.Calendar.Put description: > ... Documentation is provided in
|
943
|
+
# markdown syntax. In addition to standard markdown features, definition lists,
|
944
|
+
# tables and fenced code blocks are supported. Section headers can be provided
|
945
|
+
# and are interpreted relative to the section nesting of the context where a
|
946
|
+
# documentation fragment is embedded. Documentation from the IDL is merged with
|
947
|
+
# documentation defined via the config at normalization time, where
|
948
|
+
# documentation provided by config rules overrides IDL provided. A number of
|
949
|
+
# constructs specific to the API platform are supported in documentation text.
|
950
|
+
# In order to reference a proto element, the following notation can be used: [
|
951
|
+
# fully.qualified.proto.name][] To override the display text used for the link,
|
952
|
+
# this can be used: [display text][fully.qualified.proto.name] Text can be
|
953
|
+
# excluded from doc using the following notation: (-- internal comment --) A few
|
954
|
+
# directives are available in documentation. Note that directives must appear on
|
955
|
+
# a single line to be properly identified. The `include` directive includes a
|
956
|
+
# markdown file from an external source: (== include path/to/file ==) The `
|
957
|
+
# resource_for` directive marks a message to be the resource of a collection in
|
958
|
+
# REST view. If it is not specified, tools attempt to infer the resource from
|
959
|
+
# the operations in a collection: (== resource_for v1.shelves.books ==) The
|
960
|
+
# directive `suppress_warning` does not directly affect documentation and is
|
961
|
+
# documented together with service config validation.
|
1085
962
|
class Documentation
|
1086
963
|
include Google::Apis::Core::Hashable
|
1087
964
|
|
@@ -1090,19 +967,11 @@ module Google
|
|
1090
967
|
# @return [String]
|
1091
968
|
attr_accessor :documentation_root_url
|
1092
969
|
|
1093
|
-
# Declares a single overview page. For example:
|
1094
|
-
#
|
1095
|
-
# summary: ...
|
1096
|
-
#
|
1097
|
-
#
|
1098
|
-
# This is a shortcut for the following declaration (using pages style):
|
1099
|
-
# <pre><code>documentation:
|
1100
|
-
# summary: ...
|
1101
|
-
# pages:
|
1102
|
-
# - name: Overview
|
1103
|
-
# content: (== include overview.md ==)
|
1104
|
-
# </code></pre>
|
1105
|
-
# Note: you cannot specify both `overview` field and `pages` field.
|
970
|
+
# Declares a single overview page. For example: documentation: summary: ...
|
971
|
+
# overview: (== include overview.md ==) This is a shortcut for the following
|
972
|
+
# declaration (using pages style): documentation: summary: ... pages: - name:
|
973
|
+
# Overview content: (== include overview.md ==) Note: you cannot specify both `
|
974
|
+
# overview` field and `pages` field.
|
1106
975
|
# Corresponds to the JSON property `overview`
|
1107
976
|
# @return [String]
|
1108
977
|
attr_accessor :overview
|
@@ -1112,22 +981,20 @@ module Google
|
|
1112
981
|
# @return [Array<Google::Apis::ServicenetworkingV1beta::Page>]
|
1113
982
|
attr_accessor :pages
|
1114
983
|
|
1115
|
-
# A list of documentation rules that apply to individual API elements.
|
1116
|
-
#
|
984
|
+
# A list of documentation rules that apply to individual API elements. **NOTE:**
|
985
|
+
# All service configuration rules follow "last one wins" order.
|
1117
986
|
# Corresponds to the JSON property `rules`
|
1118
987
|
# @return [Array<Google::Apis::ServicenetworkingV1beta::DocumentationRule>]
|
1119
988
|
attr_accessor :rules
|
1120
989
|
|
1121
|
-
# Specifies the service root url if the default one (the service name
|
1122
|
-
#
|
1123
|
-
#
|
1124
|
-
# urls are relative to.
|
990
|
+
# Specifies the service root url if the default one (the service name from the
|
991
|
+
# yaml file) is not suitable. This can be seen in any fully specified service
|
992
|
+
# urls as well as sections that show a base that other urls are relative to.
|
1125
993
|
# Corresponds to the JSON property `serviceRootUrl`
|
1126
994
|
# @return [String]
|
1127
995
|
attr_accessor :service_root_url
|
1128
996
|
|
1129
|
-
# A short summary of what the service does. Can only be provided by
|
1130
|
-
# plain text.
|
997
|
+
# A short summary of what the service does. Can only be provided by plain text.
|
1131
998
|
# Corresponds to the JSON property `summary`
|
1132
999
|
# @return [String]
|
1133
1000
|
attr_accessor :summary
|
@@ -1151,8 +1018,8 @@ module Google
|
|
1151
1018
|
class DocumentationRule
|
1152
1019
|
include Google::Apis::Core::Hashable
|
1153
1020
|
|
1154
|
-
# Deprecation description of the selected element(s). It can be provided if
|
1155
|
-
#
|
1021
|
+
# Deprecation description of the selected element(s). It can be provided if an
|
1022
|
+
# element is marked as `deprecated`.
|
1156
1023
|
# Corresponds to the JSON property `deprecationDescription`
|
1157
1024
|
# @return [String]
|
1158
1025
|
attr_accessor :deprecation_description
|
@@ -1184,35 +1051,28 @@ module Google
|
|
1184
1051
|
end
|
1185
1052
|
end
|
1186
1053
|
|
1187
|
-
# `Endpoint` describes a network endpoint that serves a set of APIs.
|
1188
|
-
#
|
1189
|
-
#
|
1190
|
-
# configuration.
|
1191
|
-
#
|
1192
|
-
#
|
1193
|
-
#
|
1194
|
-
# #
|
1195
|
-
#
|
1196
|
-
# # It also allows HTTP OPTIONS calls to be passed to the backend, for
|
1197
|
-
# # it to decide whether the subsequent cross-origin request is
|
1198
|
-
# # allowed to proceed.
|
1199
|
-
# - name: library-example.googleapis.com
|
1200
|
-
# allow_cors: true
|
1054
|
+
# `Endpoint` describes a network endpoint that serves a set of APIs. A service
|
1055
|
+
# may expose any number of endpoints, and all endpoints share the same service
|
1056
|
+
# configuration, such as quota configuration and monitoring configuration.
|
1057
|
+
# Example service configuration: name: library-example.googleapis.com endpoints:
|
1058
|
+
# # Below entry makes 'google.example.library.v1.Library' # API be served from
|
1059
|
+
# endpoint address library-example.googleapis.com. # It also allows HTTP OPTIONS
|
1060
|
+
# calls to be passed to the backend, for # it to decide whether the subsequent
|
1061
|
+
# cross-origin request is # allowed to proceed. - name: library-example.
|
1062
|
+
# googleapis.com allow_cors: true
|
1201
1063
|
class Endpoint
|
1202
1064
|
include Google::Apis::Core::Hashable
|
1203
1065
|
|
1204
1066
|
# DEPRECATED: This field is no longer supported. Instead of using aliases,
|
1205
|
-
# please specify multiple google.api.Endpoint for each of the intended
|
1206
|
-
# aliases.
|
1067
|
+
# please specify multiple google.api.Endpoint for each of the intended aliases.
|
1207
1068
|
# Additional names that this endpoint will be hosted on.
|
1208
1069
|
# Corresponds to the JSON property `aliases`
|
1209
1070
|
# @return [Array<String>]
|
1210
1071
|
attr_accessor :aliases
|
1211
1072
|
|
1212
|
-
# Allowing
|
1213
|
-
#
|
1214
|
-
#
|
1215
|
-
# receive and respond to HTTP OPTIONS requests. The response will be used by
|
1073
|
+
# Allowing [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing),
|
1074
|
+
# aka cross-domain traffic, would allow the backends served from this endpoint
|
1075
|
+
# to receive and respond to HTTP OPTIONS requests. The response will be used by
|
1216
1076
|
# the browser to determine whether the subsequent cross-origin request is
|
1217
1077
|
# allowed to proceed.
|
1218
1078
|
# Corresponds to the JSON property `allowCors`
|
@@ -1226,10 +1086,9 @@ module Google
|
|
1226
1086
|
attr_accessor :name
|
1227
1087
|
|
1228
1088
|
# The specification of an Internet routable address of API frontend that will
|
1229
|
-
# handle requests to this [API
|
1230
|
-
#
|
1231
|
-
#
|
1232
|
-
# "8.8.8.8" or "myservice.appspot.com".
|
1089
|
+
# handle requests to this [API Endpoint](https://cloud.google.com/apis/design/
|
1090
|
+
# glossary). It should be either a valid IPv4 address or a fully-qualified
|
1091
|
+
# domain name. For example, "8.8.8.8" or "myservice.appspot.com".
|
1233
1092
|
# Corresponds to the JSON property `target`
|
1234
1093
|
# @return [String]
|
1235
1094
|
attr_accessor :target
|
@@ -1266,8 +1125,8 @@ module Google
|
|
1266
1125
|
# @return [Array<Google::Apis::ServicenetworkingV1beta::Option>]
|
1267
1126
|
attr_accessor :options
|
1268
1127
|
|
1269
|
-
# `SourceContext` represents information about the source of a
|
1270
|
-
#
|
1128
|
+
# `SourceContext` represents information about the source of a protobuf element,
|
1129
|
+
# like the file in which it is defined.
|
1271
1130
|
# Corresponds to the JSON property `sourceContext`
|
1272
1131
|
# @return [Google::Apis::ServicenetworkingV1beta::SourceContext]
|
1273
1132
|
attr_accessor :source_context
|
@@ -1356,8 +1215,8 @@ module Google
|
|
1356
1215
|
# @return [Fixnum]
|
1357
1216
|
attr_accessor :number
|
1358
1217
|
|
1359
|
-
# The index of the field type in `Type.oneofs`, for message or enumeration
|
1360
|
-
#
|
1218
|
+
# The index of the field type in `Type.oneofs`, for message or enumeration types.
|
1219
|
+
# The first type has index 1; zero means the type is not in the list.
|
1361
1220
|
# Corresponds to the JSON property `oneofIndex`
|
1362
1221
|
# @return [Fixnum]
|
1363
1222
|
attr_accessor :oneof_index
|
@@ -1373,8 +1232,8 @@ module Google
|
|
1373
1232
|
attr_accessor :packed
|
1374
1233
|
alias_method :packed?, :packed
|
1375
1234
|
|
1376
|
-
# The field type URL, without the scheme, for message or enumeration
|
1377
|
-
#
|
1235
|
+
# The field type URL, without the scheme, for message or enumeration types.
|
1236
|
+
# Example: `"type.googleapis.com/google.protobuf.Timestamp"`.
|
1378
1237
|
# Corresponds to the JSON property `typeUrl`
|
1379
1238
|
# @return [String]
|
1380
1239
|
attr_accessor :type_url
|
@@ -1408,21 +1267,19 @@ module Google
|
|
1408
1267
|
# @return [String]
|
1409
1268
|
attr_accessor :ip_cidr_range
|
1410
1269
|
|
1411
|
-
# Subnetwork name.
|
1412
|
-
# See https://cloud.google.com/compute/docs/vpc/
|
1270
|
+
# Subnetwork name. See https://cloud.google.com/compute/docs/vpc/
|
1413
1271
|
# Corresponds to the JSON property `name`
|
1414
1272
|
# @return [String]
|
1415
1273
|
attr_accessor :name
|
1416
1274
|
|
1417
1275
|
# In the Shared VPC host project, the VPC network that's peered with the
|
1418
|
-
# consumer network. For example:
|
1419
|
-
# `projects/1234321/global/networks/host-network`
|
1276
|
+
# consumer network. For example: `projects/1234321/global/networks/host-network`
|
1420
1277
|
# Corresponds to the JSON property `network`
|
1421
1278
|
# @return [String]
|
1422
1279
|
attr_accessor :network
|
1423
1280
|
|
1424
|
-
# This is a discovered subnet that is not within the current consumer
|
1425
|
-
#
|
1281
|
+
# This is a discovered subnet that is not within the current consumer allocated
|
1282
|
+
# ranges.
|
1426
1283
|
# Corresponds to the JSON property `outsideAllocation`
|
1427
1284
|
# @return [Boolean]
|
1428
1285
|
attr_accessor :outside_allocation
|
@@ -1442,23 +1299,22 @@ module Google
|
|
1442
1299
|
end
|
1443
1300
|
|
1444
1301
|
# Defines the HTTP configuration for an API service. It contains a list of
|
1445
|
-
# HttpRule, each specifying the mapping of an RPC method
|
1446
|
-
#
|
1302
|
+
# HttpRule, each specifying the mapping of an RPC method to one or more HTTP
|
1303
|
+
# REST API methods.
|
1447
1304
|
class Http
|
1448
1305
|
include Google::Apis::Core::Hashable
|
1449
1306
|
|
1450
1307
|
# When set to true, URL path parameters will be fully URI-decoded except in
|
1451
1308
|
# cases of single segment matches in reserved expansion, where "%2F" will be
|
1452
|
-
# left encoded.
|
1453
|
-
#
|
1454
|
-
# segment matches.
|
1309
|
+
# left encoded. The default behavior is to not decode RFC 6570 reserved
|
1310
|
+
# characters in multi segment matches.
|
1455
1311
|
# Corresponds to the JSON property `fullyDecodeReservedExpansion`
|
1456
1312
|
# @return [Boolean]
|
1457
1313
|
attr_accessor :fully_decode_reserved_expansion
|
1458
1314
|
alias_method :fully_decode_reserved_expansion?, :fully_decode_reserved_expansion
|
1459
1315
|
|
1460
|
-
# A list of HTTP configuration rules that apply to individual API methods.
|
1461
|
-
#
|
1316
|
+
# A list of HTTP configuration rules that apply to individual API methods. **
|
1317
|
+
# NOTE:** All service configuration rules follow "last one wins" order.
|
1462
1318
|
# Corresponds to the JSON property `rules`
|
1463
1319
|
# @return [Array<Google::Apis::ServicenetworkingV1beta::HttpRule>]
|
1464
1320
|
attr_accessor :rules
|
@@ -1474,251 +1330,156 @@ module Google
|
|
1474
1330
|
end
|
1475
1331
|
end
|
1476
1332
|
|
1477
|
-
# # gRPC Transcoding
|
1478
|
-
#
|
1479
|
-
#
|
1480
|
-
#
|
1481
|
-
#
|
1482
|
-
# [
|
1483
|
-
#
|
1484
|
-
#
|
1485
|
-
#
|
1486
|
-
#
|
1487
|
-
#
|
1488
|
-
# path, URL query parameters, and HTTP request body. It also controls how the
|
1489
|
-
# gRPC response message is mapped to the HTTP response body. `HttpRule` is
|
1333
|
+
# # gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC
|
1334
|
+
# method and one or more HTTP REST endpoints. It allows developers to build a
|
1335
|
+
# single API service that supports both gRPC APIs and REST APIs. Many systems,
|
1336
|
+
# including [Google APIs](https://github.com/googleapis/googleapis), [Cloud
|
1337
|
+
# Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.
|
1338
|
+
# com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/
|
1339
|
+
# envoy) proxy support this feature and use it for large scale production
|
1340
|
+
# services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping
|
1341
|
+
# specifies how different portions of the gRPC request message are mapped to the
|
1342
|
+
# URL path, URL query parameters, and HTTP request body. It also controls how
|
1343
|
+
# the gRPC response message is mapped to the HTTP response body. `HttpRule` is
|
1490
1344
|
# typically specified as an `google.api.http` annotation on the gRPC method.
|
1491
1345
|
# Each mapping specifies a URL path template and an HTTP method. The path
|
1492
1346
|
# template may refer to one or more fields in the gRPC request message, as long
|
1493
|
-
# as each field is a non-repeated field with a primitive (non-message) type.
|
1494
|
-
#
|
1495
|
-
#
|
1496
|
-
#
|
1497
|
-
#
|
1498
|
-
#
|
1499
|
-
#
|
1500
|
-
#
|
1501
|
-
#
|
1502
|
-
#
|
1503
|
-
# `
|
1504
|
-
#
|
1505
|
-
# string
|
1506
|
-
#
|
1507
|
-
#
|
1508
|
-
#
|
1509
|
-
# `
|
1510
|
-
#
|
1511
|
-
#
|
1512
|
-
#
|
1513
|
-
#
|
1514
|
-
#
|
1515
|
-
#
|
1516
|
-
#
|
1517
|
-
#
|
1518
|
-
# rpc
|
1519
|
-
#
|
1520
|
-
#
|
1521
|
-
#
|
1522
|
-
#
|
1523
|
-
# `
|
1524
|
-
#
|
1525
|
-
# message
|
1526
|
-
#
|
1527
|
-
#
|
1528
|
-
#
|
1529
|
-
#
|
1530
|
-
#
|
1531
|
-
# `
|
1532
|
-
#
|
1533
|
-
#
|
1534
|
-
#
|
1535
|
-
#
|
1536
|
-
#
|
1537
|
-
#
|
1538
|
-
#
|
1539
|
-
#
|
1540
|
-
#
|
1541
|
-
#
|
1542
|
-
#
|
1543
|
-
#
|
1544
|
-
#
|
1545
|
-
#
|
1546
|
-
#
|
1547
|
-
#
|
1548
|
-
#
|
1549
|
-
#
|
1550
|
-
#
|
1551
|
-
#
|
1552
|
-
#
|
1553
|
-
#
|
1554
|
-
#
|
1555
|
-
#
|
1556
|
-
#
|
1557
|
-
#
|
1558
|
-
# `
|
1559
|
-
# The
|
1560
|
-
#
|
1561
|
-
#
|
1562
|
-
#
|
1563
|
-
#
|
1564
|
-
#
|
1565
|
-
#
|
1566
|
-
#
|
1567
|
-
#
|
1568
|
-
#
|
1569
|
-
# the
|
1570
|
-
#
|
1571
|
-
#
|
1572
|
-
#
|
1573
|
-
#
|
1574
|
-
#
|
1575
|
-
#
|
1576
|
-
#
|
1577
|
-
#
|
1578
|
-
#
|
1579
|
-
#
|
1580
|
-
#
|
1581
|
-
# `
|
1582
|
-
# The following HTTP JSON to RPC mapping is enabled:
|
1583
|
-
# HTTP | gRPC
|
1584
|
-
# -----|-----
|
1585
|
-
# `PATCH /v1/messages/123456 ` "text": "Hi!" `` | `UpdateMessage(message_id:
|
1586
|
-
# "123456" text: "Hi!")`
|
1587
|
-
# Note that when using `*` in the body mapping, it is not possible to
|
1588
|
-
# have HTTP parameters, as all fields not bound by the path end in
|
1589
|
-
# the body. This makes this option more rarely used in practice when
|
1590
|
-
# defining REST APIs. The common usage of `*` is in custom methods
|
1591
|
-
# which don't use the URL at all for transferring data.
|
1592
|
-
# It is possible to define multiple HTTP methods for one RPC by using
|
1593
|
-
# the `additional_bindings` option. Example:
|
1594
|
-
# service Messaging `
|
1595
|
-
# rpc GetMessage(GetMessageRequest) returns (Message) `
|
1596
|
-
# option (google.api.http) = `
|
1597
|
-
# get: "/v1/messages/`message_id`"
|
1598
|
-
# additional_bindings `
|
1599
|
-
# get: "/v1/users/`user_id`/messages/`message_id`"
|
1600
|
-
# `
|
1601
|
-
# `;
|
1602
|
-
# `
|
1603
|
-
# `
|
1604
|
-
# message GetMessageRequest `
|
1605
|
-
# string message_id = 1;
|
1606
|
-
# string user_id = 2;
|
1607
|
-
# `
|
1608
|
-
# This enables the following two alternative HTTP JSON to RPC mappings:
|
1609
|
-
# HTTP | gRPC
|
1610
|
-
# -----|-----
|
1611
|
-
# `GET /v1/messages/123456` | `GetMessage(message_id: "123456")`
|
1612
|
-
# `GET /v1/users/me/messages/123456` | `GetMessage(user_id: "me" message_id:
|
1613
|
-
# "123456")`
|
1614
|
-
# ## Rules for HTTP mapping
|
1615
|
-
# 1. Leaf request fields (recursive expansion nested messages in the request
|
1616
|
-
# message) are classified into three categories:
|
1617
|
-
# - Fields referred by the path template. They are passed via the URL path.
|
1618
|
-
# - Fields referred by the HttpRule.body. They are passed via the HTTP
|
1619
|
-
# request body.
|
1620
|
-
# - All other fields are passed via the URL query parameters, and the
|
1621
|
-
# parameter name is the field path in the request message. A repeated
|
1622
|
-
# field can be represented as multiple query parameters under the same
|
1623
|
-
# name.
|
1624
|
-
# 2. If HttpRule.body is "*", there is no URL query parameter, all fields
|
1625
|
-
# are passed via URL path and HTTP request body.
|
1626
|
-
# 3. If HttpRule.body is omitted, there is no HTTP request body, all
|
1627
|
-
# fields are passed via URL path and URL query parameters.
|
1628
|
-
# ### Path template syntax
|
1629
|
-
# Template = "/" Segments [ Verb ] ;
|
1630
|
-
# Segments = Segment ` "/" Segment ` ;
|
1631
|
-
# Segment = "*" | "**" | LITERAL | Variable ;
|
1632
|
-
# Variable = "`" FieldPath [ "=" Segments ] "`" ;
|
1633
|
-
# FieldPath = IDENT ` "." IDENT ` ;
|
1634
|
-
# Verb = ":" LITERAL ;
|
1635
|
-
# The syntax `*` matches a single URL path segment. The syntax `**` matches
|
1636
|
-
# zero or more URL path segments, which must be the last part of the URL path
|
1637
|
-
# except the `Verb`.
|
1638
|
-
# The syntax `Variable` matches part of the URL path as specified by its
|
1639
|
-
# template. A variable template must not contain other variables. If a variable
|
1640
|
-
# matches a single path segment, its template may be omitted, e.g. ``var``
|
1641
|
-
# is equivalent to ``var=*``.
|
1642
|
-
# The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL`
|
1643
|
-
# contains any reserved character, such characters should be percent-encoded
|
1644
|
-
# before the matching.
|
1645
|
-
# If a variable contains exactly one path segment, such as `"`var`"` or
|
1646
|
-
# `"`var=*`"`, when such a variable is expanded into a URL path on the client
|
1647
|
-
# side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The
|
1648
|
-
# server side does the reverse decoding. Such variables show up in the
|
1649
|
-
# [Discovery
|
1650
|
-
# Document](https://developers.google.com/discovery/v1/reference/apis) as
|
1651
|
-
# ``var``.
|
1652
|
-
# If a variable contains multiple path segments, such as `"`var=foo/*`"`
|
1653
|
-
# or `"`var=**`"`, when such a variable is expanded into a URL path on the
|
1654
|
-
# client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded.
|
1655
|
-
# The server side does the reverse decoding, except "%2F" and "%2f" are left
|
1656
|
-
# unchanged. Such variables show up in the
|
1657
|
-
# [Discovery
|
1658
|
-
# Document](https://developers.google.com/discovery/v1/reference/apis) as
|
1659
|
-
# ``+var``.
|
1660
|
-
# ## Using gRPC API Service Configuration
|
1661
|
-
# gRPC API Service Configuration (service config) is a configuration language
|
1662
|
-
# for configuring a gRPC service to become a user-facing product. The
|
1663
|
-
# service config is simply the YAML representation of the `google.api.Service`
|
1664
|
-
# proto message.
|
1347
|
+
# as each field is a non-repeated field with a primitive (non-message) type. The
|
1348
|
+
# path template controls how fields of the request message are mapped to the URL
|
1349
|
+
# path. Example: service Messaging ` rpc GetMessage(GetMessageRequest) returns (
|
1350
|
+
# Message) ` option (google.api.http) = ` get: "/v1/`name=messages/*`" `; ` `
|
1351
|
+
# message GetMessageRequest ` string name = 1; // Mapped to URL path. ` message
|
1352
|
+
# Message ` string text = 1; // The resource content. ` This enables an HTTP
|
1353
|
+
# REST to gRPC mapping as below: HTTP | gRPC -----|----- `GET /v1/messages/
|
1354
|
+
# 123456` | `GetMessage(name: "messages/123456")` Any fields in the request
|
1355
|
+
# message which are not bound by the path template automatically become HTTP
|
1356
|
+
# query parameters if there is no HTTP request body. For example: service
|
1357
|
+
# Messaging ` rpc GetMessage(GetMessageRequest) returns (Message) ` option (
|
1358
|
+
# google.api.http) = ` get:"/v1/messages/`message_id`" `; ` ` message
|
1359
|
+
# GetMessageRequest ` message SubMessage ` string subfield = 1; ` string
|
1360
|
+
# message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL
|
1361
|
+
# query parameter `revision`. SubMessage sub = 3; // Mapped to URL query
|
1362
|
+
# parameter `sub.subfield`. ` This enables a HTTP JSON to RPC mapping as below:
|
1363
|
+
# HTTP | gRPC -----|----- `GET /v1/messages/123456?revision=2&sub.subfield=foo` |
|
1364
|
+
# `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: "foo"))
|
1365
|
+
# ` Note that fields which are mapped to URL query parameters must have a
|
1366
|
+
# primitive type or a repeated primitive type or a non-repeated message type. In
|
1367
|
+
# the case of a repeated type, the parameter can be repeated in the URL as `...?
|
1368
|
+
# param=A¶m=B`. In the case of a message type, each field of the message is
|
1369
|
+
# mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For
|
1370
|
+
# HTTP methods that allow a request body, the `body` field specifies the mapping.
|
1371
|
+
# Consider a REST update method on the message resource collection: service
|
1372
|
+
# Messaging ` rpc UpdateMessage(UpdateMessageRequest) returns (Message) ` option
|
1373
|
+
# (google.api.http) = ` patch: "/v1/messages/`message_id`" body: "message" `; ` `
|
1374
|
+
# message UpdateMessageRequest ` string message_id = 1; // mapped to the URL
|
1375
|
+
# Message message = 2; // mapped to the body ` The following HTTP JSON to RPC
|
1376
|
+
# mapping is enabled, where the representation of the JSON in the request body
|
1377
|
+
# is determined by protos JSON encoding: HTTP | gRPC -----|----- `PATCH /v1/
|
1378
|
+
# messages/123456 ` "text": "Hi!" `` | `UpdateMessage(message_id: "123456"
|
1379
|
+
# message ` text: "Hi!" `)` The special name `*` can be used in the body mapping
|
1380
|
+
# to define that every field not bound by the path template should be mapped to
|
1381
|
+
# the request body. This enables the following alternative definition of the
|
1382
|
+
# update method: service Messaging ` rpc UpdateMessage(Message) returns (Message)
|
1383
|
+
# ` option (google.api.http) = ` patch: "/v1/messages/`message_id`" body: "*" `;
|
1384
|
+
# ` ` message Message ` string message_id = 1; string text = 2; ` The following
|
1385
|
+
# HTTP JSON to RPC mapping is enabled: HTTP | gRPC -----|----- `PATCH /v1/
|
1386
|
+
# messages/123456 ` "text": "Hi!" `` | `UpdateMessage(message_id: "123456" text:
|
1387
|
+
# "Hi!")` Note that when using `*` in the body mapping, it is not possible to
|
1388
|
+
# have HTTP parameters, as all fields not bound by the path end in the body.
|
1389
|
+
# This makes this option more rarely used in practice when defining REST APIs.
|
1390
|
+
# The common usage of `*` is in custom methods which don't use the URL at all
|
1391
|
+
# for transferring data. It is possible to define multiple HTTP methods for one
|
1392
|
+
# RPC by using the `additional_bindings` option. Example: service Messaging `
|
1393
|
+
# rpc GetMessage(GetMessageRequest) returns (Message) ` option (google.api.http)
|
1394
|
+
# = ` get: "/v1/messages/`message_id`" additional_bindings ` get: "/v1/users/`
|
1395
|
+
# user_id`/messages/`message_id`" ` `; ` ` message GetMessageRequest ` string
|
1396
|
+
# message_id = 1; string user_id = 2; ` This enables the following two
|
1397
|
+
# alternative HTTP JSON to RPC mappings: HTTP | gRPC -----|----- `GET /v1/
|
1398
|
+
# messages/123456` | `GetMessage(message_id: "123456")` `GET /v1/users/me/
|
1399
|
+
# messages/123456` | `GetMessage(user_id: "me" message_id: "123456")` ## Rules
|
1400
|
+
# for HTTP mapping 1. Leaf request fields (recursive expansion nested messages
|
1401
|
+
# in the request message) are classified into three categories: - Fields
|
1402
|
+
# referred by the path template. They are passed via the URL path. - Fields
|
1403
|
+
# referred by the HttpRule.body. They are passed via the HTTP request body. -
|
1404
|
+
# All other fields are passed via the URL query parameters, and the parameter
|
1405
|
+
# name is the field path in the request message. A repeated field can be
|
1406
|
+
# represented as multiple query parameters under the same name. 2. If HttpRule.
|
1407
|
+
# body is "*", there is no URL query parameter, all fields are passed via URL
|
1408
|
+
# path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP
|
1409
|
+
# request body, all fields are passed via URL path and URL query parameters. ###
|
1410
|
+
# Path template syntax Template = "/" Segments [ Verb ] ; Segments = Segment ` "/
|
1411
|
+
# " Segment ` ; Segment = "*" | "**" | LITERAL | Variable ; Variable = "`"
|
1412
|
+
# FieldPath [ "=" Segments ] "`" ; FieldPath = IDENT ` "." IDENT ` ; Verb = ":"
|
1413
|
+
# LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**`
|
1414
|
+
# matches zero or more URL path segments, which must be the last part of the URL
|
1415
|
+
# path except the `Verb`. The syntax `Variable` matches part of the URL path as
|
1416
|
+
# specified by its template. A variable template must not contain other
|
1417
|
+
# variables. If a variable matches a single path segment, its template may be
|
1418
|
+
# omitted, e.g. ``var`` is equivalent to ``var=*``. The syntax `LITERAL` matches
|
1419
|
+
# literal text in the URL path. If the `LITERAL` contains any reserved character,
|
1420
|
+
# such characters should be percent-encoded before the matching. If a variable
|
1421
|
+
# contains exactly one path segment, such as `"`var`"` or `"`var=*`"`, when such
|
1422
|
+
# a variable is expanded into a URL path on the client side, all characters
|
1423
|
+
# except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse
|
1424
|
+
# decoding. Such variables show up in the [Discovery Document](https://
|
1425
|
+
# developers.google.com/discovery/v1/reference/apis) as ``var``. If a variable
|
1426
|
+
# contains multiple path segments, such as `"`var=foo/*`"` or `"`var=**`"`, when
|
1427
|
+
# such a variable is expanded into a URL path on the client side, all characters
|
1428
|
+
# except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the
|
1429
|
+
# reverse decoding, except "%2F" and "%2f" are left unchanged. Such variables
|
1430
|
+
# show up in the [Discovery Document](https://developers.google.com/discovery/v1/
|
1431
|
+
# reference/apis) as ``+var``. ## Using gRPC API Service Configuration gRPC API
|
1432
|
+
# Service Configuration (service config) is a configuration language for
|
1433
|
+
# configuring a gRPC service to become a user-facing product. The service config
|
1434
|
+
# is simply the YAML representation of the `google.api.Service` proto message.
|
1665
1435
|
# As an alternative to annotating your proto file, you can configure gRPC
|
1666
|
-
# transcoding in your service config YAML files. You do this by specifying a
|
1667
|
-
#
|
1668
|
-
# effect as the proto annotation. This can be particularly useful if you
|
1669
|
-
#
|
1670
|
-
#
|
1671
|
-
#
|
1672
|
-
#
|
1673
|
-
#
|
1674
|
-
#
|
1675
|
-
#
|
1676
|
-
#
|
1677
|
-
#
|
1678
|
-
#
|
1679
|
-
#
|
1680
|
-
#
|
1681
|
-
#
|
1682
|
-
# .
|
1683
|
-
#
|
1684
|
-
#
|
1685
|
-
#
|
1686
|
-
#
|
1687
|
-
#
|
1688
|
-
#
|
1689
|
-
# for
|
1690
|
-
#
|
1691
|
-
#
|
1692
|
-
# The path variables **must not** capture the leading "/" character. The reason
|
1693
|
-
# is that the most common use case "`var`" does not capture the leading "/"
|
1694
|
-
# character. For consistency, all path variables must share the same behavior.
|
1695
|
-
# Repeated message fields must not be mapped to URL query parameters, because
|
1696
|
-
# no client library can support such complicated mapping.
|
1697
|
-
# If an API needs to use a JSON array for request or response body, it can map
|
1698
|
-
# the request or response body to a repeated field. However, some gRPC
|
1699
|
-
# Transcoding implementations may not support this feature.
|
1436
|
+
# transcoding in your service config YAML files. You do this by specifying a `
|
1437
|
+
# HttpRule` that maps the gRPC method to a REST endpoint, achieving the same
|
1438
|
+
# effect as the proto annotation. This can be particularly useful if you have a
|
1439
|
+
# proto that is reused in multiple services. Note that any transcoding specified
|
1440
|
+
# in the service config will override any matching transcoding configuration in
|
1441
|
+
# the proto. Example: http: rules: # Selects a gRPC method and applies HttpRule
|
1442
|
+
# to it. - selector: example.v1.Messaging.GetMessage get: /v1/messages/`
|
1443
|
+
# message_id`/`sub.subfield` ## Special notes When gRPC Transcoding is used to
|
1444
|
+
# map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow
|
1445
|
+
# the [proto3 specification](https://developers.google.com/protocol-buffers/docs/
|
1446
|
+
# proto3#json). While the single segment variable follows the semantics of [RFC
|
1447
|
+
# 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String
|
1448
|
+
# Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.
|
1449
|
+
# 3 Reserved Expansion. The reason is that the Reserved Expansion does not
|
1450
|
+
# expand special characters like `?` and `#`, which would lead to invalid URLs.
|
1451
|
+
# As the result, gRPC Transcoding uses a custom encoding for multi segment
|
1452
|
+
# variables. The path variables **must not** refer to any repeated or mapped
|
1453
|
+
# field, because client libraries are not capable of handling such variable
|
1454
|
+
# expansion. The path variables **must not** capture the leading "/" character.
|
1455
|
+
# The reason is that the most common use case "`var`" does not capture the
|
1456
|
+
# leading "/" character. For consistency, all path variables must share the same
|
1457
|
+
# behavior. Repeated message fields must not be mapped to URL query parameters,
|
1458
|
+
# because no client library can support such complicated mapping. If an API
|
1459
|
+
# needs to use a JSON array for request or response body, it can map the request
|
1460
|
+
# or response body to a repeated field. However, some gRPC Transcoding
|
1461
|
+
# implementations may not support this feature.
|
1700
1462
|
class HttpRule
|
1701
1463
|
include Google::Apis::Core::Hashable
|
1702
1464
|
|
1703
|
-
# Additional HTTP bindings for the selector. Nested bindings must
|
1704
|
-
#
|
1705
|
-
#
|
1465
|
+
# Additional HTTP bindings for the selector. Nested bindings must not contain an
|
1466
|
+
# `additional_bindings` field themselves (that is, the nesting may only be one
|
1467
|
+
# level deep).
|
1706
1468
|
# Corresponds to the JSON property `additionalBindings`
|
1707
1469
|
# @return [Array<Google::Apis::ServicenetworkingV1beta::HttpRule>]
|
1708
1470
|
attr_accessor :additional_bindings
|
1709
1471
|
|
1710
|
-
# When this flag is set to true, HTTP requests will be allowed to invoke a
|
1711
|
-
#
|
1472
|
+
# When this flag is set to true, HTTP requests will be allowed to invoke a half-
|
1473
|
+
# duplex streaming method.
|
1712
1474
|
# Corresponds to the JSON property `allowHalfDuplex`
|
1713
1475
|
# @return [Boolean]
|
1714
1476
|
attr_accessor :allow_half_duplex
|
1715
1477
|
alias_method :allow_half_duplex?, :allow_half_duplex
|
1716
1478
|
|
1717
|
-
# The name of the request field whose value is mapped to the HTTP request
|
1718
|
-
#
|
1719
|
-
#
|
1720
|
-
#
|
1721
|
-
# message type.
|
1479
|
+
# The name of the request field whose value is mapped to the HTTP request body,
|
1480
|
+
# or `*` for mapping all request fields not captured by the path pattern to the
|
1481
|
+
# HTTP body, or omitted for not having any HTTP request body. NOTE: the referred
|
1482
|
+
# field must be present at the top-level of the request message type.
|
1722
1483
|
# Corresponds to the JSON property `body`
|
1723
1484
|
# @return [String]
|
1724
1485
|
attr_accessor :body
|
@@ -1733,8 +1494,7 @@ module Google
|
|
1733
1494
|
# @return [String]
|
1734
1495
|
attr_accessor :delete
|
1735
1496
|
|
1736
|
-
# Maps to HTTP GET. Used for listing and getting information about
|
1737
|
-
# resources.
|
1497
|
+
# Maps to HTTP GET. Used for listing and getting information about resources.
|
1738
1498
|
# Corresponds to the JSON property `get`
|
1739
1499
|
# @return [String]
|
1740
1500
|
attr_accessor :get
|
@@ -1755,16 +1515,15 @@ module Google
|
|
1755
1515
|
attr_accessor :put
|
1756
1516
|
|
1757
1517
|
# Optional. The name of the response field whose value is mapped to the HTTP
|
1758
|
-
# response body. When omitted, the entire response message will be used
|
1759
|
-
#
|
1760
|
-
#
|
1761
|
-
# message type.
|
1518
|
+
# response body. When omitted, the entire response message will be used as the
|
1519
|
+
# HTTP response body. NOTE: The referred field must be present at the top-level
|
1520
|
+
# of the response message type.
|
1762
1521
|
# Corresponds to the JSON property `responseBody`
|
1763
1522
|
# @return [String]
|
1764
1523
|
attr_accessor :response_body
|
1765
1524
|
|
1766
|
-
# Selects a method to which this rule applies.
|
1767
|
-
#
|
1525
|
+
# Selects a method to which this rule applies. Refer to selector for syntax
|
1526
|
+
# details.
|
1768
1527
|
# Corresponds to the JSON property `selector`
|
1769
1528
|
# @return [String]
|
1770
1529
|
attr_accessor :selector
|
@@ -1803,13 +1562,12 @@ module Google
|
|
1803
1562
|
# @return [String]
|
1804
1563
|
attr_accessor :query
|
1805
1564
|
|
1806
|
-
# The value prefix. The value format is "value_prefix`token`"
|
1807
|
-
#
|
1808
|
-
#
|
1809
|
-
# If
|
1810
|
-
#
|
1811
|
-
#
|
1812
|
-
# value_prefix="Bearer " with a space at the end.
|
1565
|
+
# The value prefix. The value format is "value_prefix`token`" Only applies to "
|
1566
|
+
# in" header type. Must be empty for "in" query type. If not empty, the header
|
1567
|
+
# value has to match (case sensitive) this prefix. If not matched, JWT will not
|
1568
|
+
# be extracted. If matched, JWT will be extracted after the prefix is removed.
|
1569
|
+
# For example, for "Authorization: Bearer `JWT`", value_prefix="Bearer " with a
|
1570
|
+
# space at the end.
|
1813
1571
|
# Corresponds to the JSON property `valuePrefix`
|
1814
1572
|
# @return [String]
|
1815
1573
|
attr_accessor :value_prefix
|
@@ -1857,8 +1615,8 @@ module Google
|
|
1857
1615
|
end
|
1858
1616
|
end
|
1859
1617
|
|
1860
|
-
# ListConnectionsResponse is the response to list peering states for the
|
1861
|
-
#
|
1618
|
+
# ListConnectionsResponse is the response to list peering states for the given
|
1619
|
+
# service and consumer project.
|
1862
1620
|
class ListConnectionsResponse
|
1863
1621
|
include Google::Apis::Core::Hashable
|
1864
1622
|
|
@@ -1877,39 +1635,35 @@ module Google
|
|
1877
1635
|
end
|
1878
1636
|
end
|
1879
1637
|
|
1880
|
-
# A description of a log type. Example in YAML format:
|
1881
|
-
#
|
1882
|
-
#
|
1883
|
-
# display_name: Activity
|
1884
|
-
# labels:
|
1885
|
-
# - key: /customer_id
|
1638
|
+
# A description of a log type. Example in YAML format: - name: library.
|
1639
|
+
# googleapis.com/activity_history description: The history of borrowing and
|
1640
|
+
# returning library items. display_name: Activity labels: - key: /customer_id
|
1886
1641
|
# description: Identifier of a library customer
|
1887
1642
|
class LogDescriptor
|
1888
1643
|
include Google::Apis::Core::Hashable
|
1889
1644
|
|
1890
|
-
# A human-readable description of this log. This information appears in
|
1891
|
-
#
|
1645
|
+
# A human-readable description of this log. This information appears in the
|
1646
|
+
# documentation and can contain details.
|
1892
1647
|
# Corresponds to the JSON property `description`
|
1893
1648
|
# @return [String]
|
1894
1649
|
attr_accessor :description
|
1895
1650
|
|
1896
|
-
# The human-readable name for this log. This information appears on
|
1897
|
-
#
|
1651
|
+
# The human-readable name for this log. This information appears on the user
|
1652
|
+
# interface and should be concise.
|
1898
1653
|
# Corresponds to the JSON property `displayName`
|
1899
1654
|
# @return [String]
|
1900
1655
|
attr_accessor :display_name
|
1901
1656
|
|
1902
|
-
# The set of labels that are available to describe a specific log entry.
|
1903
|
-
#
|
1904
|
-
# considered invalid.
|
1657
|
+
# The set of labels that are available to describe a specific log entry. Runtime
|
1658
|
+
# requests that contain labels not specified here are considered invalid.
|
1905
1659
|
# Corresponds to the JSON property `labels`
|
1906
1660
|
# @return [Array<Google::Apis::ServicenetworkingV1beta::LabelDescriptor>]
|
1907
1661
|
attr_accessor :labels
|
1908
1662
|
|
1909
|
-
# The name of the log. It must be less than 512 characters long and can
|
1910
|
-
#
|
1911
|
-
#
|
1912
|
-
#
|
1663
|
+
# The name of the log. It must be less than 512 characters long and can include
|
1664
|
+
# the following characters: upper- and lower-case alphanumeric characters [A-Za-
|
1665
|
+
# z0-9], and punctuation characters including slash, underscore, hyphen, period [
|
1666
|
+
# /_-.].
|
1913
1667
|
# Corresponds to the JSON property `name`
|
1914
1668
|
# @return [String]
|
1915
1669
|
attr_accessor :name
|
@@ -1927,48 +1681,30 @@ module Google
|
|
1927
1681
|
end
|
1928
1682
|
end
|
1929
1683
|
|
1930
|
-
# Logging configuration of the service.
|
1931
|
-
#
|
1932
|
-
#
|
1933
|
-
# log is sent to
|
1934
|
-
#
|
1935
|
-
#
|
1936
|
-
# -
|
1937
|
-
# labels:
|
1938
|
-
# -
|
1939
|
-
#
|
1940
|
-
#
|
1941
|
-
# description: The name of the branch.
|
1942
|
-
# logs:
|
1943
|
-
# - name: activity_history
|
1944
|
-
# labels:
|
1945
|
-
# - key: /customer_id
|
1946
|
-
# - name: purchase_history
|
1947
|
-
# logging:
|
1948
|
-
# producer_destinations:
|
1949
|
-
# - monitored_resource: library.googleapis.com/branch
|
1950
|
-
# logs:
|
1951
|
-
# - activity_history
|
1952
|
-
# - purchase_history
|
1953
|
-
# consumer_destinations:
|
1954
|
-
# - monitored_resource: library.googleapis.com/branch
|
1955
|
-
# logs:
|
1956
|
-
# - activity_history
|
1684
|
+
# Logging configuration of the service. The following example shows how to
|
1685
|
+
# configure logs to be sent to the producer and consumer projects. In the
|
1686
|
+
# example, the `activity_history` log is sent to both the producer and consumer
|
1687
|
+
# projects, whereas the `purchase_history` log is only sent to the producer
|
1688
|
+
# project. monitored_resources: - type: library.googleapis.com/branch labels: -
|
1689
|
+
# key: /city description: The city where the library branch is located in. - key:
|
1690
|
+
# /name description: The name of the branch. logs: - name: activity_history
|
1691
|
+
# labels: - key: /customer_id - name: purchase_history logging:
|
1692
|
+
# producer_destinations: - monitored_resource: library.googleapis.com/branch
|
1693
|
+
# logs: - activity_history - purchase_history consumer_destinations: -
|
1694
|
+
# monitored_resource: library.googleapis.com/branch logs: - activity_history
|
1957
1695
|
class Logging
|
1958
1696
|
include Google::Apis::Core::Hashable
|
1959
1697
|
|
1960
|
-
# Logging configurations for sending logs to the consumer project.
|
1961
|
-
#
|
1962
|
-
#
|
1963
|
-
# one consumer destination.
|
1698
|
+
# Logging configurations for sending logs to the consumer project. There can be
|
1699
|
+
# multiple consumer destinations, each one must have a different monitored
|
1700
|
+
# resource type. A log can be used in at most one consumer destination.
|
1964
1701
|
# Corresponds to the JSON property `consumerDestinations`
|
1965
1702
|
# @return [Array<Google::Apis::ServicenetworkingV1beta::LoggingDestination>]
|
1966
1703
|
attr_accessor :consumer_destinations
|
1967
1704
|
|
1968
|
-
# Logging configurations for sending logs to the producer project.
|
1969
|
-
#
|
1970
|
-
#
|
1971
|
-
# one producer destination.
|
1705
|
+
# Logging configurations for sending logs to the producer project. There can be
|
1706
|
+
# multiple producer destinations, each one must have a different monitored
|
1707
|
+
# resource type. A log can be used in at most one producer destination.
|
1972
1708
|
# Corresponds to the JSON property `producerDestinations`
|
1973
1709
|
# @return [Array<Google::Apis::ServicenetworkingV1beta::LoggingDestination>]
|
1974
1710
|
attr_accessor :producer_destinations
|
@@ -1984,21 +1720,20 @@ module Google
|
|
1984
1720
|
end
|
1985
1721
|
end
|
1986
1722
|
|
1987
|
-
# Configuration of a specific logging destination (the producer project
|
1988
|
-
#
|
1723
|
+
# Configuration of a specific logging destination (the producer project or the
|
1724
|
+
# consumer project).
|
1989
1725
|
class LoggingDestination
|
1990
1726
|
include Google::Apis::Core::Hashable
|
1991
1727
|
|
1992
|
-
# Names of the logs to be sent to this destination. Each name must
|
1993
|
-
#
|
1994
|
-
#
|
1995
|
-
# the service name followed by "/".
|
1728
|
+
# Names of the logs to be sent to this destination. Each name must be defined in
|
1729
|
+
# the Service.logs section. If the log name is not a domain scoped name, it will
|
1730
|
+
# be automatically prefixed with the service name followed by "/".
|
1996
1731
|
# Corresponds to the JSON property `logs`
|
1997
1732
|
# @return [Array<String>]
|
1998
1733
|
attr_accessor :logs
|
1999
1734
|
|
2000
|
-
# The monitored resource type. The type must be defined in the
|
2001
|
-
#
|
1735
|
+
# The monitored resource type. The type must be defined in the Service.
|
1736
|
+
# monitored_resources section.
|
2002
1737
|
# Corresponds to the JSON property `monitoredResource`
|
2003
1738
|
# @return [String]
|
2004
1739
|
attr_accessor :monitored_resource
|
@@ -2073,16 +1808,13 @@ module Google
|
|
2073
1808
|
|
2074
1809
|
# Defines a metric type and its schema. Once a metric descriptor is created,
|
2075
1810
|
# deleting or altering it stops data collection and makes the metric type's
|
2076
|
-
# existing data unusable.
|
2077
|
-
#
|
2078
|
-
#
|
2079
|
-
#
|
2080
|
-
#
|
2081
|
-
#
|
2082
|
-
#
|
2083
|
-
# * Maximum of default 10 labels per metric descriptor is allowed.
|
2084
|
-
# The default maximum limit can be overridden. Please follow
|
2085
|
-
# https://cloud.google.com/monitoring/quotas
|
1811
|
+
# existing data unusable. The following are specific rules for service defined
|
1812
|
+
# Monitoring metric descriptors: * `type`, `metric_kind`, `value_type` and `
|
1813
|
+
# description` fields are all required. The `unit` field must be specified if
|
1814
|
+
# the `value_type` is any of DOUBLE, INT64, DISTRIBUTION. * Maximum of default
|
1815
|
+
# 500 metric descriptors per service is allowed. * Maximum of default 10 labels
|
1816
|
+
# per metric descriptor is allowed. The default maximum limit can be overridden.
|
1817
|
+
# Please follow https://cloud.google.com/monitoring/quotas
|
2086
1818
|
class MetricDescriptor
|
2087
1819
|
include Google::Apis::Core::Hashable
|
2088
1820
|
|
@@ -2091,26 +1823,21 @@ module Google
|
|
2091
1823
|
# @return [String]
|
2092
1824
|
attr_accessor :description
|
2093
1825
|
|
2094
|
-
# A concise name for the metric, which can be displayed in user interfaces.
|
2095
|
-
#
|
2096
|
-
#
|
2097
|
-
#
|
1826
|
+
# A concise name for the metric, which can be displayed in user interfaces. Use
|
1827
|
+
# sentence case without an ending period, for example "Request count". This
|
1828
|
+
# field is optional but it is recommended to be set for any metrics associated
|
1829
|
+
# with user-visible concepts, such as Quota.
|
2098
1830
|
# Corresponds to the JSON property `displayName`
|
2099
1831
|
# @return [String]
|
2100
1832
|
attr_accessor :display_name
|
2101
1833
|
|
2102
|
-
# The set of labels that can be used to describe a specific
|
2103
|
-
#
|
2104
|
-
#
|
2105
|
-
# *
|
2106
|
-
#
|
2107
|
-
#
|
2108
|
-
#
|
2109
|
-
# For example, the
|
2110
|
-
# `appengine.googleapis.com/http/server/response_latencies` metric
|
2111
|
-
# type has a label for the HTTP response code, `response_code`, so
|
2112
|
-
# you can look at latencies for successful responses or just
|
2113
|
-
# for responses that failed.
|
1834
|
+
# The set of labels that can be used to describe a specific instance of this
|
1835
|
+
# metric type. The label key name must follow: * Only upper and lower-case
|
1836
|
+
# letters, digits and underscores (_) are allowed. * Label name must start with
|
1837
|
+
# a letter or digit. * The maximum length of a label name is 100 characters. For
|
1838
|
+
# example, the `appengine.googleapis.com/http/server/response_latencies` metric
|
1839
|
+
# type has a label for the HTTP response code, `response_code`, so you can look
|
1840
|
+
# at latencies for successful responses or just for responses that failed.
|
2114
1841
|
# Corresponds to the JSON property `labels`
|
2115
1842
|
# @return [Array<Google::Apis::ServicenetworkingV1beta::LabelDescriptor>]
|
2116
1843
|
attr_accessor :labels
|
@@ -2125,17 +1852,16 @@ module Google
|
|
2125
1852
|
# @return [Google::Apis::ServicenetworkingV1beta::MetricDescriptorMetadata]
|
2126
1853
|
attr_accessor :metadata
|
2127
1854
|
|
2128
|
-
# Whether the metric records instantaneous values, changes to a value, etc.
|
2129
|
-
#
|
1855
|
+
# Whether the metric records instantaneous values, changes to a value, etc. Some
|
1856
|
+
# combinations of `metric_kind` and `value_type` might not be supported.
|
2130
1857
|
# Corresponds to the JSON property `metricKind`
|
2131
1858
|
# @return [String]
|
2132
1859
|
attr_accessor :metric_kind
|
2133
1860
|
|
2134
|
-
# Read-only. If present, then a time
|
2135
|
-
#
|
2136
|
-
#
|
2137
|
-
#
|
2138
|
-
# resource types listed here.
|
1861
|
+
# Read-only. If present, then a time series, which is identified partially by a
|
1862
|
+
# metric type and a MonitoredResourceDescriptor, that is associated with this
|
1863
|
+
# metric type can only be associated with one of the monitored resource types
|
1864
|
+
# listed here.
|
2139
1865
|
# Corresponds to the JSON property `monitoredResourceTypes`
|
2140
1866
|
# @return [Array<String>]
|
2141
1867
|
attr_accessor :monitored_resource_types
|
@@ -2145,116 +1871,73 @@ module Google
|
|
2145
1871
|
# @return [String]
|
2146
1872
|
attr_accessor :name
|
2147
1873
|
|
2148
|
-
# The metric type, including its DNS name prefix. The type is not
|
2149
|
-
# URL-encoded.
|
1874
|
+
# The metric type, including its DNS name prefix. The type is not URL-encoded.
|
2150
1875
|
# All service defined metrics must be prefixed with the service name, in the
|
2151
|
-
# format of ``service name`/`relative metric name``, such as
|
2152
|
-
#
|
2153
|
-
# name must follow:
|
1876
|
+
# format of ``service name`/`relative metric name``, such as `cloudsql.
|
1877
|
+
# googleapis.com/database/cpu/utilization`. The relative metric name must follow:
|
2154
1878
|
# * Only upper and lower-case letters, digits, '/' and underscores '_' are
|
2155
|
-
# allowed.
|
2156
|
-
#
|
2157
|
-
#
|
2158
|
-
#
|
2159
|
-
#
|
2160
|
-
#
|
2161
|
-
# Metric types should use a natural hierarchical grouping. For example:
|
2162
|
-
# "custom.googleapis.com/invoice/paid/amount"
|
2163
|
-
# "external.googleapis.com/prometheus/up"
|
2164
|
-
# "appengine.googleapis.com/http/server/response_latencies"
|
1879
|
+
# allowed. * The maximum number of characters allowed for the
|
1880
|
+
# relative_metric_name is 100. All user-defined metric types have the DNS name `
|
1881
|
+
# custom.googleapis.com`, `external.googleapis.com`, or `logging.googleapis.com/
|
1882
|
+
# user/`. Metric types should use a natural hierarchical grouping. For example: "
|
1883
|
+
# custom.googleapis.com/invoice/paid/amount" "external.googleapis.com/prometheus/
|
1884
|
+
# up" "appengine.googleapis.com/http/server/response_latencies"
|
2165
1885
|
# Corresponds to the JSON property `type`
|
2166
1886
|
# @return [String]
|
2167
1887
|
attr_accessor :type
|
2168
1888
|
|
2169
|
-
# The units in which the metric value is reported. It is only applicable
|
2170
|
-
#
|
2171
|
-
#
|
2172
|
-
#
|
2173
|
-
# value of `
|
2174
|
-
#
|
2175
|
-
#
|
2176
|
-
#
|
2177
|
-
#
|
2178
|
-
#
|
2179
|
-
# `
|
2180
|
-
#
|
2181
|
-
#
|
2182
|
-
#
|
2183
|
-
#
|
2184
|
-
#
|
2185
|
-
#
|
2186
|
-
#
|
2187
|
-
#
|
2188
|
-
# * `
|
2189
|
-
# * `
|
2190
|
-
# * `
|
2191
|
-
# * `
|
2192
|
-
# * `
|
2193
|
-
#
|
2194
|
-
#
|
2195
|
-
#
|
2196
|
-
#
|
2197
|
-
#
|
2198
|
-
#
|
2199
|
-
# * `
|
2200
|
-
#
|
2201
|
-
# * `
|
2202
|
-
#
|
2203
|
-
# * `
|
2204
|
-
#
|
2205
|
-
#
|
2206
|
-
#
|
2207
|
-
#
|
2208
|
-
#
|
2209
|
-
# *
|
2210
|
-
#
|
2211
|
-
#
|
2212
|
-
# * `
|
2213
|
-
#
|
2214
|
-
#
|
2215
|
-
# * `Ti` tebi (2^40)
|
2216
|
-
# * `Pi` pebi (2^50)
|
2217
|
-
# **Grammar**
|
2218
|
-
# The grammar also includes these connectors:
|
2219
|
-
# * `/` division or ratio (as an infix operator). For examples,
|
2220
|
-
# `kBy/`email`` or `MiBy/10ms` (although you should almost never
|
2221
|
-
# have `/s` in a metric `unit`; rates should always be computed at
|
2222
|
-
# query time from the underlying cumulative or delta value).
|
2223
|
-
# * `.` multiplication or composition (as an infix operator). For
|
2224
|
-
# examples, `GBy.d` or `k`watt`.h`.
|
2225
|
-
# The grammar for a unit is as follows:
|
2226
|
-
# Expression = Component ` "." Component ` ` "/" Component ` ;
|
2227
|
-
# Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ]
|
2228
|
-
# | Annotation
|
2229
|
-
# | "1"
|
2230
|
-
# ;
|
2231
|
-
# Annotation = "`" NAME "`" ;
|
2232
|
-
# Notes:
|
2233
|
-
# * `Annotation` is just a comment if it follows a `UNIT`. If the annotation
|
2234
|
-
# is used alone, then the unit is equivalent to `1`. For examples,
|
2235
|
-
# ``request`/s == 1/s`, `By`transmitted`/s == By/s`.
|
2236
|
-
# * `NAME` is a sequence of non-blank printable ASCII characters not
|
2237
|
-
# containing ``` or ```.
|
2238
|
-
# * `1` represents a unitary [dimensionless
|
2239
|
-
# unit](https://en.wikipedia.org/wiki/Dimensionless_quantity) of 1, such
|
2240
|
-
# as in `1/s`. It is typically used when none of the basic units are
|
2241
|
-
# appropriate. For example, "new users per day" can be represented as
|
2242
|
-
# `1/d` or ``new-users`/d` (and a metric value `5` would mean "5 new
|
2243
|
-
# users). Alternatively, "thousands of page views per day" would be
|
2244
|
-
# represented as `1000/d` or `k1/d` or `k`page_views`/d` (and a metric
|
2245
|
-
# value of `5.3` would mean "5300 page views per day").
|
2246
|
-
# * `%` represents dimensionless value of 1/100, and annotates values giving
|
2247
|
-
# a percentage (so the metric values are typically in the range of 0..100,
|
2248
|
-
# and a metric value `3` means "3 percent").
|
2249
|
-
# * `10^2.%` indicates a metric contains a ratio, typically in the range
|
2250
|
-
# 0..1, that will be multiplied by 100 and displayed as a percentage
|
2251
|
-
# (so a metric value `0.03` means "3 percent").
|
1889
|
+
# The units in which the metric value is reported. It is only applicable if the `
|
1890
|
+
# value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The `unit` defines the
|
1891
|
+
# representation of the stored metric values. Different systems may scale the
|
1892
|
+
# values to be more easily displayed (so a value of `0.02KBy` _might_ be
|
1893
|
+
# displayed as `20By`, and a value of `3523KBy` _might_ be displayed as `3.5MBy`)
|
1894
|
+
# . However, if the `unit` is `KBy`, then the value of the metric is always in
|
1895
|
+
# thousands of bytes, no matter how it may be displayed.. If you want a custom
|
1896
|
+
# metric to record the exact number of CPU-seconds used by a job, you can create
|
1897
|
+
# an `INT64 CUMULATIVE` metric whose `unit` is `s`CPU`` (or equivalently `1s`CPU`
|
1898
|
+
# ` or just `s`). If the job uses 12,005 CPU-seconds, then the value is written
|
1899
|
+
# as `12005`. Alternatively, if you want a custom metric to record data in a
|
1900
|
+
# more granular way, you can create a `DOUBLE CUMULATIVE` metric whose `unit` is
|
1901
|
+
# `ks`CPU``, and then write the value `12.005` (which is `12005/1000`), or use `
|
1902
|
+
# Kis`CPU`` and write `11.723` (which is `12005/1024`). The supported units are
|
1903
|
+
# a subset of [The Unified Code for Units of Measure](http://unitsofmeasure.org/
|
1904
|
+
# ucum.html) standard: **Basic units (UNIT)** * `bit` bit * `By` byte * `s`
|
1905
|
+
# second * `min` minute * `h` hour * `d` day * `1` dimensionless **Prefixes (
|
1906
|
+
# PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga (10^9) * `T` tera (10^
|
1907
|
+
# 12) * `P` peta (10^15) * `E` exa (10^18) * `Z` zetta (10^21) * `Y` yotta (10^
|
1908
|
+
# 24) * `m` milli (10^-3) * `u` micro (10^-6) * `n` nano (10^-9) * `p` pico (10^-
|
1909
|
+
# 12) * `f` femto (10^-15) * `a` atto (10^-18) * `z` zepto (10^-21) * `y` yocto (
|
1910
|
+
# 10^-24) * `Ki` kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (
|
1911
|
+
# 2^40) * `Pi` pebi (2^50) **Grammar** The grammar also includes these
|
1912
|
+
# connectors: * `/` division or ratio (as an infix operator). For examples, `kBy/
|
1913
|
+
# `email`` or `MiBy/10ms` (although you should almost never have `/s` in a
|
1914
|
+
# metric `unit`; rates should always be computed at query time from the
|
1915
|
+
# underlying cumulative or delta value). * `.` multiplication or composition (as
|
1916
|
+
# an infix operator). For examples, `GBy.d` or `k`watt`.h`. The grammar for a
|
1917
|
+
# unit is as follows: Expression = Component ` "." Component ` ` "/" Component `
|
1918
|
+
# ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ;
|
1919
|
+
# Annotation = "`" NAME "`" ; Notes: * `Annotation` is just a comment if it
|
1920
|
+
# follows a `UNIT`. If the annotation is used alone, then the unit is equivalent
|
1921
|
+
# to `1`. For examples, ``request`/s == 1/s`, `By`transmitted`/s == By/s`. * `
|
1922
|
+
# NAME` is a sequence of non-blank printable ASCII characters not containing ```
|
1923
|
+
# or ```. * `1` represents a unitary [dimensionless unit](https://en.wikipedia.
|
1924
|
+
# org/wiki/Dimensionless_quantity) of 1, such as in `1/s`. It is typically used
|
1925
|
+
# when none of the basic units are appropriate. For example, "new users per day"
|
1926
|
+
# can be represented as `1/d` or ``new-users`/d` (and a metric value `5` would
|
1927
|
+
# mean "5 new users). Alternatively, "thousands of page views per day" would be
|
1928
|
+
# represented as `1000/d` or `k1/d` or `k`page_views`/d` (and a metric value of `
|
1929
|
+
# 5.3` would mean "5300 page views per day"). * `%` represents dimensionless
|
1930
|
+
# value of 1/100, and annotates values giving a percentage (so the metric values
|
1931
|
+
# are typically in the range of 0..100, and a metric value `3` means "3 percent")
|
1932
|
+
# . * `10^2.%` indicates a metric contains a ratio, typically in the range 0..1,
|
1933
|
+
# that will be multiplied by 100 and displayed as a percentage (so a metric
|
1934
|
+
# value `0.03` means "3 percent").
|
2252
1935
|
# Corresponds to the JSON property `unit`
|
2253
1936
|
# @return [String]
|
2254
1937
|
attr_accessor :unit
|
2255
1938
|
|
2256
|
-
# Whether the measurement is an integer, a floating-point number, etc.
|
2257
|
-
#
|
1939
|
+
# Whether the measurement is an integer, a floating-point number, etc. Some
|
1940
|
+
# combinations of `metric_kind` and `value_type` might not be supported.
|
2258
1941
|
# Corresponds to the JSON property `valueType`
|
2259
1942
|
# @return [String]
|
2260
1943
|
attr_accessor :value_type
|
@@ -2283,9 +1966,9 @@ module Google
|
|
2283
1966
|
class MetricDescriptorMetadata
|
2284
1967
|
include Google::Apis::Core::Hashable
|
2285
1968
|
|
2286
|
-
# The delay of data points caused by ingestion. Data points older than this
|
2287
|
-
#
|
2288
|
-
#
|
1969
|
+
# The delay of data points caused by ingestion. Data points older than this age
|
1970
|
+
# are guaranteed to be ingested and available to be read, excluding data loss
|
1971
|
+
# due to errors.
|
2289
1972
|
# Corresponds to the JSON property `ingestDelay`
|
2290
1973
|
# @return [String]
|
2291
1974
|
attr_accessor :ingest_delay
|
@@ -2297,8 +1980,8 @@ module Google
|
|
2297
1980
|
|
2298
1981
|
# The sampling period of metric data points. For metrics which are written
|
2299
1982
|
# periodically, consecutive data points are stored at this time interval,
|
2300
|
-
# excluding data loss due to errors. Metrics with a higher granularity have
|
2301
|
-
#
|
1983
|
+
# excluding data loss due to errors. Metrics with a higher granularity have a
|
1984
|
+
# smaller sampling period.
|
2302
1985
|
# Corresponds to the JSON property `samplePeriod`
|
2303
1986
|
# @return [String]
|
2304
1987
|
attr_accessor :sample_period
|
@@ -2315,22 +1998,21 @@ module Google
|
|
2315
1998
|
end
|
2316
1999
|
end
|
2317
2000
|
|
2318
|
-
# Bind API methods to metrics. Binding a method to a metric causes that
|
2319
|
-
#
|
2001
|
+
# Bind API methods to metrics. Binding a method to a metric causes that metric's
|
2002
|
+
# configured quota behaviors to apply to the method call.
|
2320
2003
|
class MetricRule
|
2321
2004
|
include Google::Apis::Core::Hashable
|
2322
2005
|
|
2323
2006
|
# Metrics to update when the selected methods are called, and the associated
|
2324
|
-
# cost applied to each metric.
|
2325
|
-
#
|
2326
|
-
#
|
2327
|
-
# The value must not be negative.
|
2007
|
+
# cost applied to each metric. The key of the map is the metric name, and the
|
2008
|
+
# values are the amount increased for the metric against which the quota limits
|
2009
|
+
# are defined. The value must not be negative.
|
2328
2010
|
# Corresponds to the JSON property `metricCosts`
|
2329
2011
|
# @return [Hash<String,Fixnum>]
|
2330
2012
|
attr_accessor :metric_costs
|
2331
2013
|
|
2332
|
-
# Selects the methods to which this rule applies.
|
2333
|
-
#
|
2014
|
+
# Selects the methods to which this rule applies. Refer to selector for syntax
|
2015
|
+
# details.
|
2334
2016
|
# Corresponds to the JSON property `selector`
|
2335
2017
|
# @return [String]
|
2336
2018
|
attr_accessor :selector
|
@@ -2348,66 +2030,33 @@ module Google
|
|
2348
2030
|
|
2349
2031
|
# Declares an API Interface to be included in this interface. The including
|
2350
2032
|
# interface must redeclare all the methods from the included interface, but
|
2351
|
-
# documentation and options are inherited as follows:
|
2352
|
-
#
|
2353
|
-
#
|
2354
|
-
#
|
2355
|
-
#
|
2356
|
-
#
|
2357
|
-
#
|
2358
|
-
#
|
2359
|
-
#
|
2360
|
-
#
|
2361
|
-
#
|
2362
|
-
#
|
2363
|
-
#
|
2364
|
-
#
|
2365
|
-
#
|
2366
|
-
#
|
2367
|
-
#
|
2368
|
-
# `
|
2369
|
-
# `
|
2370
|
-
#
|
2371
|
-
#
|
2372
|
-
#
|
2373
|
-
#
|
2374
|
-
#
|
2375
|
-
#
|
2376
|
-
# `
|
2377
|
-
# `
|
2378
|
-
# Example of a mixin configuration:
|
2379
|
-
# apis:
|
2380
|
-
# - name: google.storage.v2.Storage
|
2381
|
-
# mixins:
|
2382
|
-
# - name: google.acl.v1.AccessControl
|
2383
|
-
# The mixin construct implies that all methods in `AccessControl` are
|
2384
|
-
# also declared with same name and request/response types in
|
2385
|
-
# `Storage`. A documentation generator or annotation processor will
|
2386
|
-
# see the effective `Storage.GetAcl` method after inherting
|
2387
|
-
# documentation and annotations as follows:
|
2388
|
-
# service Storage `
|
2389
|
-
# // Get the underlying ACL object.
|
2390
|
-
# rpc GetAcl(GetAclRequest) returns (Acl) `
|
2391
|
-
# option (google.api.http).get = "/v2/`resource=**`:getAcl";
|
2392
|
-
# `
|
2393
|
-
# ...
|
2394
|
-
# `
|
2395
|
-
# Note how the version in the path pattern changed from `v1` to `v2`.
|
2396
|
-
# If the `root` field in the mixin is specified, it should be a
|
2397
|
-
# relative path under which inherited HTTP paths are placed. Example:
|
2398
|
-
# apis:
|
2399
|
-
# - name: google.storage.v2.Storage
|
2400
|
-
# mixins:
|
2401
|
-
# - name: google.acl.v1.AccessControl
|
2402
|
-
# root: acls
|
2403
|
-
# This implies the following inherited HTTP annotation:
|
2404
|
-
# service Storage `
|
2405
|
-
# // Get the underlying ACL object.
|
2406
|
-
# rpc GetAcl(GetAclRequest) returns (Acl) `
|
2407
|
-
# option (google.api.http).get = "/v2/acls/`resource=**`:getAcl";
|
2408
|
-
# `
|
2409
|
-
# ...
|
2410
|
-
# `
|
2033
|
+
# documentation and options are inherited as follows: - If after comment and
|
2034
|
+
# whitespace stripping, the documentation string of the redeclared method is
|
2035
|
+
# empty, it will be inherited from the original method. - Each annotation
|
2036
|
+
# belonging to the service config (http, visibility) which is not set in the
|
2037
|
+
# redeclared method will be inherited. - If an http annotation is inherited, the
|
2038
|
+
# path pattern will be modified as follows. Any version prefix will be replaced
|
2039
|
+
# by the version of the including interface plus the root path if specified.
|
2040
|
+
# Example of a simple mixin: package google.acl.v1; service AccessControl ` //
|
2041
|
+
# Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) `
|
2042
|
+
# option (google.api.http).get = "/v1/`resource=**`:getAcl"; ` ` package google.
|
2043
|
+
# storage.v2; service Storage ` // rpc GetAcl(GetAclRequest) returns (Acl); //
|
2044
|
+
# Get a data record. rpc GetData(GetDataRequest) returns (Data) ` option (google.
|
2045
|
+
# api.http).get = "/v2/`resource=**`"; ` ` Example of a mixin configuration:
|
2046
|
+
# apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.
|
2047
|
+
# AccessControl The mixin construct implies that all methods in `AccessControl`
|
2048
|
+
# are also declared with same name and request/response types in `Storage`. A
|
2049
|
+
# documentation generator or annotation processor will see the effective `
|
2050
|
+
# Storage.GetAcl` method after inherting documentation and annotations as
|
2051
|
+
# follows: service Storage ` // Get the underlying ACL object. rpc GetAcl(
|
2052
|
+
# GetAclRequest) returns (Acl) ` option (google.api.http).get = "/v2/`resource=**
|
2053
|
+
# `:getAcl"; ` ... ` Note how the version in the path pattern changed from `v1`
|
2054
|
+
# to `v2`. If the `root` field in the mixin is specified, it should be a
|
2055
|
+
# relative path under which inherited HTTP paths are placed. Example: apis: -
|
2056
|
+
# name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl
|
2057
|
+
# root: acls This implies the following inherited HTTP annotation: service
|
2058
|
+
# Storage ` // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (
|
2059
|
+
# Acl) ` option (google.api.http).get = "/v2/acls/`resource=**`:getAcl"; ` ... `
|
2411
2060
|
class Mixin
|
2412
2061
|
include Google::Apis::Core::Hashable
|
2413
2062
|
|
@@ -2416,8 +2065,7 @@ module Google
|
|
2416
2065
|
# @return [String]
|
2417
2066
|
attr_accessor :name
|
2418
2067
|
|
2419
|
-
# If non-empty specifies a path under which inherited HTTP paths
|
2420
|
-
# are rooted.
|
2068
|
+
# If non-empty specifies a path under which inherited HTTP paths are rooted.
|
2421
2069
|
# Corresponds to the JSON property `root`
|
2422
2070
|
# @return [String]
|
2423
2071
|
attr_accessor :root
|
@@ -2433,51 +2081,42 @@ module Google
|
|
2433
2081
|
end
|
2434
2082
|
end
|
2435
2083
|
|
2436
|
-
# An object that describes the schema of a MonitoredResource object using a
|
2437
|
-
#
|
2438
|
-
#
|
2439
|
-
#
|
2440
|
-
#
|
2441
|
-
#
|
2442
|
-
#
|
2443
|
-
#
|
2444
|
-
#
|
2445
|
-
#
|
2446
|
-
#
|
2447
|
-
#
|
2448
|
-
#
|
2449
|
-
#
|
2450
|
-
# * Maximum of default 5 service defined monitored resource descriptors
|
2451
|
-
# is allowed per service.
|
2452
|
-
# * Maximum of default 10 labels per monitored resource is allowed.
|
2453
|
-
# The default maximum limit can be overridden. Please follow
|
2454
|
-
# https://cloud.google.com/monitoring/quotas
|
2084
|
+
# An object that describes the schema of a MonitoredResource object using a type
|
2085
|
+
# name and a set of labels. For example, the monitored resource descriptor for
|
2086
|
+
# Google Compute Engine VM instances has a type of `"gce_instance"` and
|
2087
|
+
# specifies the use of the labels `"instance_id"` and `"zone"` to identify
|
2088
|
+
# particular VM instances. Different services can support different monitored
|
2089
|
+
# resource types. The following are specific rules to service defined monitored
|
2090
|
+
# resources for Monitoring and Logging: * The `type`, `display_name`, `
|
2091
|
+
# description`, `labels` and `launch_stage` fields are all required. * The first
|
2092
|
+
# label of the monitored resource descriptor must be `resource_container`. There
|
2093
|
+
# are legacy monitored resource descritptors start with `project_id`. * It must
|
2094
|
+
# include a `location` label. * Maximum of default 5 service defined monitored
|
2095
|
+
# resource descriptors is allowed per service. * Maximum of default 10 labels
|
2096
|
+
# per monitored resource is allowed. The default maximum limit can be overridden.
|
2097
|
+
# Please follow https://cloud.google.com/monitoring/quotas
|
2455
2098
|
class MonitoredResourceDescriptor
|
2456
2099
|
include Google::Apis::Core::Hashable
|
2457
2100
|
|
2458
|
-
# Optional. A detailed description of the monitored resource type that might
|
2459
|
-
#
|
2101
|
+
# Optional. A detailed description of the monitored resource type that might be
|
2102
|
+
# used in documentation.
|
2460
2103
|
# Corresponds to the JSON property `description`
|
2461
2104
|
# @return [String]
|
2462
2105
|
attr_accessor :description
|
2463
2106
|
|
2464
2107
|
# Optional. A concise name for the monitored resource type that might be
|
2465
|
-
# displayed in user interfaces. It should be a Title Cased Noun Phrase,
|
2466
|
-
#
|
2467
|
-
# `"Google Cloud SQL Database"`.
|
2108
|
+
# displayed in user interfaces. It should be a Title Cased Noun Phrase, without
|
2109
|
+
# any article or other determiners. For example, `"Google Cloud SQL Database"`.
|
2468
2110
|
# Corresponds to the JSON property `displayName`
|
2469
2111
|
# @return [String]
|
2470
2112
|
attr_accessor :display_name
|
2471
2113
|
|
2472
2114
|
# Required. A set of labels used to describe instances of this monitored
|
2473
|
-
# resource type.
|
2474
|
-
#
|
2475
|
-
# *
|
2476
|
-
#
|
2477
|
-
#
|
2478
|
-
# * The maximum length of a label name is 100 characters.
|
2479
|
-
# For example, an individual Google Cloud SQL database is
|
2480
|
-
# identified by values for the labels `database_id` and `location`.
|
2115
|
+
# resource type. The label key name must follow: * Only upper and lower-case
|
2116
|
+
# letters, digits and underscores (_) are allowed. * Label name must start with
|
2117
|
+
# a letter or digit. * The maximum length of a label name is 100 characters. For
|
2118
|
+
# example, an individual Google Cloud SQL database is identified by values for
|
2119
|
+
# the labels `database_id` and `location`.
|
2481
2120
|
# Corresponds to the JSON property `labels`
|
2482
2121
|
# @return [Array<Google::Apis::ServicenetworkingV1beta::LabelDescriptor>]
|
2483
2122
|
attr_accessor :labels
|
@@ -2487,27 +2126,25 @@ module Google
|
|
2487
2126
|
# @return [String]
|
2488
2127
|
attr_accessor :launch_stage
|
2489
2128
|
|
2490
|
-
# Optional. The resource name of the monitored resource descriptor:
|
2491
|
-
#
|
2492
|
-
# `type`
|
2493
|
-
#
|
2494
|
-
#
|
2495
|
-
#
|
2129
|
+
# Optional. The resource name of the monitored resource descriptor: `"projects/`
|
2130
|
+
# project_id`/monitoredResourceDescriptors/`type`"` where `type` is the value of
|
2131
|
+
# the `type` field in this object and `project_id` is a project ID that provides
|
2132
|
+
# API-specific context for accessing the type. APIs that do not use project
|
2133
|
+
# information can use the resource name format `"monitoredResourceDescriptors/`
|
2134
|
+
# type`"`.
|
2496
2135
|
# Corresponds to the JSON property `name`
|
2497
2136
|
# @return [String]
|
2498
2137
|
attr_accessor :name
|
2499
2138
|
|
2500
|
-
# Required. The monitored resource type. For example, the type
|
2501
|
-
#
|
2502
|
-
#
|
2503
|
-
#
|
2504
|
-
#
|
2505
|
-
#
|
2506
|
-
#
|
2507
|
-
#
|
2508
|
-
#
|
2509
|
-
# is 100.
|
2510
|
-
# Note there are legacy service monitored resources not following this rule.
|
2139
|
+
# Required. The monitored resource type. For example, the type `
|
2140
|
+
# cloudsql_database` represents databases in Google Cloud SQL. All service
|
2141
|
+
# defined monitored resource types must be prefixed with the service name, in
|
2142
|
+
# the format of ``service name`/`relative resource name``. The relative resource
|
2143
|
+
# name must follow: * Only upper and lower-case letters and digits are allowed. *
|
2144
|
+
# It must start with upper case character and is recommended to use Upper Camel
|
2145
|
+
# Case style. * The maximum number of characters allowed for the
|
2146
|
+
# relative_resource_name is 100. Note there are legacy service monitored
|
2147
|
+
# resources not following this rule.
|
2511
2148
|
# Corresponds to the JSON property `type`
|
2512
2149
|
# @return [String]
|
2513
2150
|
attr_accessor :type
|
@@ -2527,75 +2164,47 @@ module Google
|
|
2527
2164
|
end
|
2528
2165
|
end
|
2529
2166
|
|
2530
|
-
# Monitoring configuration of the service.
|
2531
|
-
#
|
2532
|
-
#
|
2533
|
-
#
|
2534
|
-
#
|
2535
|
-
#
|
2536
|
-
#
|
2537
|
-
#
|
2538
|
-
# -
|
2539
|
-
#
|
2540
|
-
#
|
2541
|
-
#
|
2542
|
-
#
|
2543
|
-
# - key:
|
2544
|
-
#
|
2545
|
-
#
|
2546
|
-
#
|
2547
|
-
#
|
2548
|
-
#
|
2549
|
-
#
|
2550
|
-
#
|
2551
|
-
#
|
2552
|
-
# description: "The count of books that have been returned."
|
2553
|
-
# launch_stage: GA
|
2554
|
-
# metric_kind: DELTA
|
2555
|
-
# value_type: INT64
|
2556
|
-
# unit: "1"
|
2557
|
-
# labels:
|
2558
|
-
# - key: customer_id
|
2559
|
-
# description: "The id of the customer."
|
2560
|
-
# - name: library.googleapis.com/book/num_overdue
|
2561
|
-
# display_name: "Books Overdue"
|
2562
|
-
# description: "The current number of overdue books."
|
2563
|
-
# launch_stage: GA
|
2564
|
-
# metric_kind: GAUGE
|
2565
|
-
# value_type: INT64
|
2566
|
-
# unit: "1"
|
2567
|
-
# labels:
|
2568
|
-
# - key: customer_id
|
2569
|
-
# description: "The id of the customer."
|
2570
|
-
# monitoring:
|
2571
|
-
# producer_destinations:
|
2572
|
-
# - monitored_resource: library.googleapis.com/Branch
|
2573
|
-
# metrics:
|
2574
|
-
# - library.googleapis.com/book/returned_count
|
2575
|
-
# consumer_destinations:
|
2576
|
-
# - monitored_resource: library.googleapis.com/Branch
|
2577
|
-
# metrics:
|
2578
|
-
# - library.googleapis.com/book/returned_count
|
2579
|
-
# - library.googleapis.com/book/num_overdue
|
2167
|
+
# Monitoring configuration of the service. The example below shows how to
|
2168
|
+
# configure monitored resources and metrics for monitoring. In the example, a
|
2169
|
+
# monitored resource and two metrics are defined. The `library.googleapis.com/
|
2170
|
+
# book/returned_count` metric is sent to both producer and consumer projects,
|
2171
|
+
# whereas the `library.googleapis.com/book/num_overdue` metric is only sent to
|
2172
|
+
# the consumer project. monitored_resources: - type: library.googleapis.com/
|
2173
|
+
# Branch display_name: "Library Branch" description: "A branch of a library."
|
2174
|
+
# launch_stage: GA labels: - key: resource_container description: "The Cloud
|
2175
|
+
# container (ie. project id) for the Branch." - key: location description: "The
|
2176
|
+
# location of the library branch." - key: branch_id description: "The id of the
|
2177
|
+
# branch." metrics: - name: library.googleapis.com/book/returned_count
|
2178
|
+
# display_name: "Books Returned" description: "The count of books that have been
|
2179
|
+
# returned." launch_stage: GA metric_kind: DELTA value_type: INT64 unit: "1"
|
2180
|
+
# labels: - key: customer_id description: "The id of the customer." - name:
|
2181
|
+
# library.googleapis.com/book/num_overdue display_name: "Books Overdue"
|
2182
|
+
# description: "The current number of overdue books." launch_stage: GA
|
2183
|
+
# metric_kind: GAUGE value_type: INT64 unit: "1" labels: - key: customer_id
|
2184
|
+
# description: "The id of the customer." monitoring: producer_destinations: -
|
2185
|
+
# monitored_resource: library.googleapis.com/Branch metrics: - library.
|
2186
|
+
# googleapis.com/book/returned_count consumer_destinations: - monitored_resource:
|
2187
|
+
# library.googleapis.com/Branch metrics: - library.googleapis.com/book/
|
2188
|
+
# returned_count - library.googleapis.com/book/num_overdue
|
2580
2189
|
class Monitoring
|
2581
2190
|
include Google::Apis::Core::Hashable
|
2582
2191
|
|
2583
|
-
# Monitoring configurations for sending metrics to the consumer project.
|
2584
|
-
#
|
2585
|
-
#
|
2586
|
-
#
|
2587
|
-
#
|
2588
|
-
#
|
2192
|
+
# Monitoring configurations for sending metrics to the consumer project. There
|
2193
|
+
# can be multiple consumer destinations. A monitored resource type may appear in
|
2194
|
+
# multiple monitoring destinations if different aggregations are needed for
|
2195
|
+
# different sets of metrics associated with that monitored resource type. A
|
2196
|
+
# monitored resource and metric pair may only be used once in the Monitoring
|
2197
|
+
# configuration.
|
2589
2198
|
# Corresponds to the JSON property `consumerDestinations`
|
2590
2199
|
# @return [Array<Google::Apis::ServicenetworkingV1beta::MonitoringDestination>]
|
2591
2200
|
attr_accessor :consumer_destinations
|
2592
2201
|
|
2593
|
-
# Monitoring configurations for sending metrics to the producer project.
|
2594
|
-
#
|
2595
|
-
#
|
2596
|
-
#
|
2597
|
-
#
|
2598
|
-
#
|
2202
|
+
# Monitoring configurations for sending metrics to the producer project. There
|
2203
|
+
# can be multiple producer destinations. A monitored resource type may appear in
|
2204
|
+
# multiple monitoring destinations if different aggregations are needed for
|
2205
|
+
# different sets of metrics associated with that monitored resource type. A
|
2206
|
+
# monitored resource and metric pair may only be used once in the Monitoring
|
2207
|
+
# configuration.
|
2599
2208
|
# Corresponds to the JSON property `producerDestinations`
|
2600
2209
|
# @return [Array<Google::Apis::ServicenetworkingV1beta::MonitoringDestination>]
|
2601
2210
|
attr_accessor :producer_destinations
|
@@ -2611,19 +2220,19 @@ module Google
|
|
2611
2220
|
end
|
2612
2221
|
end
|
2613
2222
|
|
2614
|
-
# Configuration of a specific monitoring destination (the producer project
|
2615
|
-
#
|
2223
|
+
# Configuration of a specific monitoring destination (the producer project or
|
2224
|
+
# the consumer project).
|
2616
2225
|
class MonitoringDestination
|
2617
2226
|
include Google::Apis::Core::Hashable
|
2618
2227
|
|
2619
|
-
# Types of the metrics to report to this monitoring destination.
|
2620
|
-
#
|
2228
|
+
# Types of the metrics to report to this monitoring destination. Each type must
|
2229
|
+
# be defined in Service.metrics section.
|
2621
2230
|
# Corresponds to the JSON property `metrics`
|
2622
2231
|
# @return [Array<String>]
|
2623
2232
|
attr_accessor :metrics
|
2624
2233
|
|
2625
|
-
# The monitored resource type. The type must be defined in
|
2626
|
-
#
|
2234
|
+
# The monitored resource type. The type must be defined in Service.
|
2235
|
+
# monitored_resources section.
|
2627
2236
|
# Corresponds to the JSON property `monitoredResource`
|
2628
2237
|
# @return [String]
|
2629
2238
|
attr_accessor :monitored_resource
|
@@ -2640,27 +2249,25 @@ module Google
|
|
2640
2249
|
end
|
2641
2250
|
|
2642
2251
|
# OAuth scopes are a way to define data and permissions on data. For example,
|
2643
|
-
# there are scopes defined for "Read-only access to Google Calendar" and
|
2644
|
-
#
|
2645
|
-
#
|
2646
|
-
#
|
2647
|
-
#
|
2648
|
-
#
|
2649
|
-
#
|
2650
|
-
#
|
2651
|
-
#
|
2652
|
-
#
|
2653
|
-
#
|
2654
|
-
#
|
2655
|
-
# due to the backend requiring additional scopes or permissions.
|
2252
|
+
# there are scopes defined for "Read-only access to Google Calendar" and "Access
|
2253
|
+
# to Cloud Platform". Users can consent to a scope for an application, giving it
|
2254
|
+
# permission to access that data on their behalf. OAuth scope specifications
|
2255
|
+
# should be fairly coarse grained; a user will need to see and understand the
|
2256
|
+
# text description of what your scope means. In most cases: use one or at most
|
2257
|
+
# two OAuth scopes for an entire family of products. If your product has
|
2258
|
+
# multiple APIs, you should probably be sharing the OAuth scope across all of
|
2259
|
+
# those APIs. When you need finer grained OAuth consent screens: talk with your
|
2260
|
+
# product management about how developers will use them in practice. Please note
|
2261
|
+
# that even though each of the canonical scopes is enough for a request to be
|
2262
|
+
# accepted and passed to the backend, a request can still fail due to the
|
2263
|
+
# backend requiring additional scopes or permissions.
|
2656
2264
|
class OAuthRequirements
|
2657
2265
|
include Google::Apis::Core::Hashable
|
2658
2266
|
|
2659
|
-
# The list of publicly documented OAuth scopes that are allowed access. An
|
2660
|
-
#
|
2661
|
-
#
|
2662
|
-
#
|
2663
|
-
# https://www.googleapis.com/auth/calendar.read
|
2267
|
+
# The list of publicly documented OAuth scopes that are allowed access. An OAuth
|
2268
|
+
# token containing any of these scopes will be accepted. Example:
|
2269
|
+
# canonical_scopes: https://www.googleapis.com/auth/calendar, https://www.
|
2270
|
+
# googleapis.com/auth/calendar.read
|
2664
2271
|
# Corresponds to the JSON property `canonicalScopes`
|
2665
2272
|
# @return [String]
|
2666
2273
|
attr_accessor :canonical_scopes
|
@@ -2680,47 +2287,45 @@ module Google
|
|
2680
2287
|
class Operation
|
2681
2288
|
include Google::Apis::Core::Hashable
|
2682
2289
|
|
2683
|
-
# If the value is `false`, it means the operation is still in progress.
|
2684
|
-
#
|
2685
|
-
# available.
|
2290
|
+
# If the value is `false`, it means the operation is still in progress. If `true`
|
2291
|
+
# , the operation is completed, and either `error` or `response` is available.
|
2686
2292
|
# Corresponds to the JSON property `done`
|
2687
2293
|
# @return [Boolean]
|
2688
2294
|
attr_accessor :done
|
2689
2295
|
alias_method :done?, :done
|
2690
2296
|
|
2691
|
-
# The `Status` type defines a logical error model that is suitable for
|
2692
|
-
#
|
2693
|
-
#
|
2694
|
-
#
|
2695
|
-
#
|
2696
|
-
#
|
2297
|
+
# The `Status` type defines a logical error model that is suitable for different
|
2298
|
+
# programming environments, including REST APIs and RPC APIs. It is used by [
|
2299
|
+
# gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
|
2300
|
+
# data: error code, error message, and error details. You can find out more
|
2301
|
+
# about this error model and how to work with it in the [API Design Guide](https:
|
2302
|
+
# //cloud.google.com/apis/design/errors).
|
2697
2303
|
# Corresponds to the JSON property `error`
|
2698
2304
|
# @return [Google::Apis::ServicenetworkingV1beta::Status]
|
2699
2305
|
attr_accessor :error
|
2700
2306
|
|
2701
|
-
# Service-specific metadata associated with the operation.
|
2702
|
-
#
|
2703
|
-
#
|
2704
|
-
#
|
2307
|
+
# Service-specific metadata associated with the operation. It typically contains
|
2308
|
+
# progress information and common metadata such as create time. Some services
|
2309
|
+
# might not provide such metadata. Any method that returns a long-running
|
2310
|
+
# operation should document the metadata type, if any.
|
2705
2311
|
# Corresponds to the JSON property `metadata`
|
2706
2312
|
# @return [Hash<String,Object>]
|
2707
2313
|
attr_accessor :metadata
|
2708
2314
|
|
2709
2315
|
# The server-assigned name, which is only unique within the same service that
|
2710
|
-
# originally returns it. If you use the default HTTP mapping, the
|
2711
|
-
#
|
2316
|
+
# originally returns it. If you use the default HTTP mapping, the `name` should
|
2317
|
+
# be a resource name ending with `operations/`unique_id``.
|
2712
2318
|
# Corresponds to the JSON property `name`
|
2713
2319
|
# @return [String]
|
2714
2320
|
attr_accessor :name
|
2715
2321
|
|
2716
|
-
# The normal response of the operation in case of success.
|
2717
|
-
# method returns no data on success, such as `Delete`, the response is
|
2718
|
-
#
|
2719
|
-
#
|
2720
|
-
#
|
2721
|
-
#
|
2722
|
-
#
|
2723
|
-
# `TakeSnapshotResponse`.
|
2322
|
+
# The normal response of the operation in case of success. If the original
|
2323
|
+
# method returns no data on success, such as `Delete`, the response is `google.
|
2324
|
+
# protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`,
|
2325
|
+
# the response should be the resource. For other methods, the response should
|
2326
|
+
# have the type `XxxResponse`, where `Xxx` is the original method name. For
|
2327
|
+
# example, if the original method name is `TakeSnapshot()`, the inferred
|
2328
|
+
# response type is `TakeSnapshotResponse`.
|
2724
2329
|
# Corresponds to the JSON property `response`
|
2725
2330
|
# @return [Hash<String,Object>]
|
2726
2331
|
attr_accessor :response
|
@@ -2745,17 +2350,17 @@ module Google
|
|
2745
2350
|
include Google::Apis::Core::Hashable
|
2746
2351
|
|
2747
2352
|
# The option's name. For protobuf built-in options (options defined in
|
2748
|
-
# descriptor.proto), this is the short name. For example, `"map_entry"`.
|
2749
|
-
#
|
2750
|
-
#
|
2353
|
+
# descriptor.proto), this is the short name. For example, `"map_entry"`. For
|
2354
|
+
# custom options, it should be the fully-qualified name. For example, `"google.
|
2355
|
+
# api.http"`.
|
2751
2356
|
# Corresponds to the JSON property `name`
|
2752
2357
|
# @return [String]
|
2753
2358
|
attr_accessor :name
|
2754
2359
|
|
2755
|
-
# The option's value packed in an Any message. If the value is a primitive,
|
2756
|
-
#
|
2757
|
-
#
|
2758
|
-
#
|
2360
|
+
# The option's value packed in an Any message. If the value is a primitive, the
|
2361
|
+
# corresponding wrapper type defined in google/protobuf/wrappers.proto should be
|
2362
|
+
# used. If the value is an enum, it should be stored as an int32 value using the
|
2363
|
+
# google.protobuf.Int32Value type.
|
2759
2364
|
# Corresponds to the JSON property `value`
|
2760
2365
|
# @return [Hash<String,Object>]
|
2761
2366
|
attr_accessor :value
|
@@ -2776,32 +2381,25 @@ module Google
|
|
2776
2381
|
class Page
|
2777
2382
|
include Google::Apis::Core::Hashable
|
2778
2383
|
|
2779
|
-
# The Markdown content of the page. You can use
|
2780
|
-
#
|
2384
|
+
# The Markdown content of the page. You can use (== include `path` ==) to
|
2385
|
+
# include content from a Markdown file.
|
2781
2386
|
# Corresponds to the JSON property `content`
|
2782
2387
|
# @return [String]
|
2783
2388
|
attr_accessor :content
|
2784
2389
|
|
2785
|
-
# The name of the page. It will be used as an identity of the page to
|
2786
|
-
#
|
2787
|
-
#
|
2788
|
-
#
|
2789
|
-
#
|
2790
|
-
#
|
2791
|
-
#
|
2792
|
-
# content: (== include tutorial.md ==)
|
2793
|
-
# subpages:
|
2794
|
-
# - name: Java
|
2795
|
-
# content: (== include tutorial_java.md ==)
|
2796
|
-
# </code></pre>
|
2797
|
-
# You can reference `Java` page using Markdown reference link syntax:
|
2798
|
-
# `Java`.
|
2390
|
+
# The name of the page. It will be used as an identity of the page to generate
|
2391
|
+
# URI of the page, text of the link to this page in navigation, etc. The full
|
2392
|
+
# page name (start from the root page name to this page concatenated with `.`)
|
2393
|
+
# can be used as reference to the page in your documentation. For example: pages:
|
2394
|
+
# - name: Tutorial content: (== include tutorial.md ==) subpages: - name: Java
|
2395
|
+
# content: (== include tutorial_java.md ==) You can reference `Java` page using
|
2396
|
+
# Markdown reference link syntax: `Java`.
|
2799
2397
|
# Corresponds to the JSON property `name`
|
2800
2398
|
# @return [String]
|
2801
2399
|
attr_accessor :name
|
2802
2400
|
|
2803
|
-
# Subpages of this page. The order of subpages specified here will be
|
2804
|
-
#
|
2401
|
+
# Subpages of this page. The order of subpages specified here will be honored in
|
2402
|
+
# the generated docset.
|
2805
2403
|
# Corresponds to the JSON property `subpages`
|
2806
2404
|
# @return [Array<Google::Apis::ServicenetworkingV1beta::Page>]
|
2807
2405
|
attr_accessor :subpages
|
@@ -2822,20 +2420,17 @@ module Google
|
|
2822
2420
|
class PolicyBinding
|
2823
2421
|
include Google::Apis::Core::Hashable
|
2824
2422
|
|
2825
|
-
# Required. Member to bind the role with. See
|
2826
|
-
#
|
2827
|
-
#
|
2828
|
-
# - user:myuser@mydomain.com
|
2829
|
-
# - serviceAccount:my-service-account@app.gserviceaccount.com
|
2423
|
+
# Required. Member to bind the role with. See /iam/docs/reference/rest/v1/Policy#
|
2424
|
+
# Binding for how to format each member. Eg. - user:myuser@mydomain.com -
|
2425
|
+
# serviceAccount:my-service-account@app.gserviceaccount.com
|
2830
2426
|
# Corresponds to the JSON property `member`
|
2831
2427
|
# @return [String]
|
2832
2428
|
attr_accessor :member
|
2833
2429
|
|
2834
2430
|
# Required. Role to apply. Only whitelisted roles can be used at the specified
|
2835
|
-
# granularity. The role must be one of the following:
|
2836
|
-
#
|
2837
|
-
# project
|
2838
|
-
# - 'roles/compute.securityAdmin' applied on the shared VPC host project
|
2431
|
+
# granularity. The role must be one of the following: - 'roles/container.
|
2432
|
+
# hostServiceAgentUser' applied on the shared VPC host project - 'roles/compute.
|
2433
|
+
# securityAdmin' applied on the shared VPC host project
|
2839
2434
|
# Corresponds to the JSON property `role`
|
2840
2435
|
# @return [String]
|
2841
2436
|
attr_accessor :role
|
@@ -2851,46 +2446,25 @@ module Google
|
|
2851
2446
|
end
|
2852
2447
|
end
|
2853
2448
|
|
2854
|
-
# Quota configuration helps to achieve fairness and budgeting in service
|
2855
|
-
#
|
2856
|
-
#
|
2857
|
-
#
|
2858
|
-
#
|
2859
|
-
#
|
2860
|
-
#
|
2861
|
-
#
|
2862
|
-
#
|
2863
|
-
#
|
2864
|
-
#
|
2865
|
-
# -
|
2866
|
-
#
|
2867
|
-
#
|
2868
|
-
#
|
2869
|
-
#
|
2870
|
-
#
|
2871
|
-
#
|
2872
|
-
#
|
2873
|
-
# # consuming at twice rate as the DeleteBook method.
|
2874
|
-
# metric_rules:
|
2875
|
-
# - selector: "*"
|
2876
|
-
# metric_costs:
|
2877
|
-
# library.googleapis.com/read_calls: 1
|
2878
|
-
# - selector: google.example.library.v1.LibraryService.UpdateBook
|
2879
|
-
# metric_costs:
|
2880
|
-
# library.googleapis.com/write_calls: 2
|
2881
|
-
# - selector: google.example.library.v1.LibraryService.DeleteBook
|
2882
|
-
# metric_costs:
|
2883
|
-
# library.googleapis.com/write_calls: 1
|
2884
|
-
# Corresponding Metric definition:
|
2885
|
-
# metrics:
|
2886
|
-
# - name: library.googleapis.com/read_calls
|
2887
|
-
# display_name: Read requests
|
2888
|
-
# metric_kind: DELTA
|
2889
|
-
# value_type: INT64
|
2890
|
-
# - name: library.googleapis.com/write_calls
|
2891
|
-
# display_name: Write requests
|
2892
|
-
# metric_kind: DELTA
|
2893
|
-
# value_type: INT64
|
2449
|
+
# Quota configuration helps to achieve fairness and budgeting in service usage.
|
2450
|
+
# The metric based quota configuration works this way: - The service
|
2451
|
+
# configuration defines a set of metrics. - For API calls, the quota.
|
2452
|
+
# metric_rules maps methods to metrics with corresponding costs. - The quota.
|
2453
|
+
# limits defines limits on the metrics, which will be used for quota checks at
|
2454
|
+
# runtime. An example quota configuration in yaml format: quota: limits: - name:
|
2455
|
+
# apiWriteQpsPerProject metric: library.googleapis.com/write_calls unit: "1/min/`
|
2456
|
+
# project`" # rate limit for consumer projects values: STANDARD: 10000 # The
|
2457
|
+
# metric rules bind all methods to the read_calls metric, # except for the
|
2458
|
+
# UpdateBook and DeleteBook methods. These two methods # are mapped to the
|
2459
|
+
# write_calls metric, with the UpdateBook method # consuming at twice rate as
|
2460
|
+
# the DeleteBook method. metric_rules: - selector: "*" metric_costs: library.
|
2461
|
+
# googleapis.com/read_calls: 1 - selector: google.example.library.v1.
|
2462
|
+
# LibraryService.UpdateBook metric_costs: library.googleapis.com/write_calls: 2 -
|
2463
|
+
# selector: google.example.library.v1.LibraryService.DeleteBook metric_costs:
|
2464
|
+
# library.googleapis.com/write_calls: 1 Corresponding Metric definition: metrics:
|
2465
|
+
# - name: library.googleapis.com/read_calls display_name: Read requests
|
2466
|
+
# metric_kind: DELTA value_type: INT64 - name: library.googleapis.com/
|
2467
|
+
# write_calls display_name: Write requests metric_kind: DELTA value_type: INT64
|
2894
2468
|
class Quota
|
2895
2469
|
include Google::Apis::Core::Hashable
|
2896
2470
|
|
@@ -2899,8 +2473,8 @@ module Google
|
|
2899
2473
|
# @return [Array<Google::Apis::ServicenetworkingV1beta::QuotaLimit>]
|
2900
2474
|
attr_accessor :limits
|
2901
2475
|
|
2902
|
-
# List of `MetricRule` definitions, each one mapping a selected method to one
|
2903
|
-
#
|
2476
|
+
# List of `MetricRule` definitions, each one mapping a selected method to one or
|
2477
|
+
# more metrics.
|
2904
2478
|
# Corresponds to the JSON property `metricRules`
|
2905
2479
|
# @return [Array<Google::Apis::ServicenetworkingV1beta::MetricRule>]
|
2906
2480
|
attr_accessor :metric_rules
|
@@ -2917,95 +2491,89 @@ module Google
|
|
2917
2491
|
end
|
2918
2492
|
|
2919
2493
|
# `QuotaLimit` defines a specific limit that applies over a specified duration
|
2920
|
-
# for a limit type. There can be at most one limit for a duration and limit
|
2921
|
-
#
|
2494
|
+
# for a limit type. There can be at most one limit for a duration and limit type
|
2495
|
+
# combination defined within a `QuotaGroup`.
|
2922
2496
|
class QuotaLimit
|
2923
2497
|
include Google::Apis::Core::Hashable
|
2924
2498
|
|
2925
|
-
# Default number of tokens that can be consumed during the specified
|
2926
|
-
#
|
2927
|
-
#
|
2928
|
-
#
|
2929
|
-
#
|
2930
|
-
#
|
2931
|
-
#
|
2932
|
-
# Used by group-based quotas only.
|
2499
|
+
# Default number of tokens that can be consumed during the specified duration.
|
2500
|
+
# This is the number of tokens assigned when a client application developer
|
2501
|
+
# activates the service for his/her project. Specifying a value of 0 will block
|
2502
|
+
# all requests. This can be used if you are provisioning quota to selected
|
2503
|
+
# consumers and blocking others. Similarly, a value of -1 will indicate an
|
2504
|
+
# unlimited quota. No other negative values are allowed. Used by group-based
|
2505
|
+
# quotas only.
|
2933
2506
|
# Corresponds to the JSON property `defaultLimit`
|
2934
2507
|
# @return [Fixnum]
|
2935
2508
|
attr_accessor :default_limit
|
2936
2509
|
|
2937
|
-
# Optional. User-visible, extended description for this quota limit.
|
2938
|
-
#
|
2939
|
-
#
|
2510
|
+
# Optional. User-visible, extended description for this quota limit. Should be
|
2511
|
+
# used only when more context is needed to understand this limit than provided
|
2512
|
+
# by the limit's display name (see: `display_name`).
|
2940
2513
|
# Corresponds to the JSON property `description`
|
2941
2514
|
# @return [String]
|
2942
2515
|
attr_accessor :description
|
2943
2516
|
|
2944
|
-
# User-visible display name for this limit.
|
2945
|
-
#
|
2946
|
-
#
|
2947
|
-
#
|
2517
|
+
# User-visible display name for this limit. Optional. If not set, the UI will
|
2518
|
+
# provide a default display name based on the quota configuration. This field
|
2519
|
+
# can be used to override the default display name generated from the
|
2520
|
+
# configuration.
|
2948
2521
|
# Corresponds to the JSON property `displayName`
|
2949
2522
|
# @return [String]
|
2950
2523
|
attr_accessor :display_name
|
2951
2524
|
|
2952
|
-
# Duration of this limit in textual notation. Must be "100s" or "1d".
|
2953
|
-
#
|
2525
|
+
# Duration of this limit in textual notation. Must be "100s" or "1d". Used by
|
2526
|
+
# group-based quotas only.
|
2954
2527
|
# Corresponds to the JSON property `duration`
|
2955
2528
|
# @return [String]
|
2956
2529
|
attr_accessor :duration
|
2957
2530
|
|
2958
|
-
# Free tier value displayed in the Developers Console for this limit.
|
2959
|
-
#
|
2960
|
-
#
|
2961
|
-
#
|
2962
|
-
#
|
2963
|
-
#
|
2964
|
-
# Used by group-based quotas only.
|
2531
|
+
# Free tier value displayed in the Developers Console for this limit. The free
|
2532
|
+
# tier is the number of tokens that will be subtracted from the billed amount
|
2533
|
+
# when billing is enabled. This field can only be set on a limit with duration "
|
2534
|
+
# 1d", in a billable group; it is invalid on any other limit. If this field is
|
2535
|
+
# not set, it defaults to 0, indicating that there is no free tier for this
|
2536
|
+
# service. Used by group-based quotas only.
|
2965
2537
|
# Corresponds to the JSON property `freeTier`
|
2966
2538
|
# @return [Fixnum]
|
2967
2539
|
attr_accessor :free_tier
|
2968
2540
|
|
2969
|
-
# Maximum number of tokens that can be consumed during the specified
|
2970
|
-
#
|
2971
|
-
#
|
2972
|
-
#
|
2973
|
-
#
|
2974
|
-
#
|
2975
|
-
# Used by group-based quotas only.
|
2541
|
+
# Maximum number of tokens that can be consumed during the specified duration.
|
2542
|
+
# Client application developers can override the default limit up to this
|
2543
|
+
# maximum. If specified, this value cannot be set to a value less than the
|
2544
|
+
# default limit. If not specified, it is set to the default limit. To allow
|
2545
|
+
# clients to apply overrides with no upper bound, set this to -1, indicating
|
2546
|
+
# unlimited maximum quota. Used by group-based quotas only.
|
2976
2547
|
# Corresponds to the JSON property `maxLimit`
|
2977
2548
|
# @return [Fixnum]
|
2978
2549
|
attr_accessor :max_limit
|
2979
2550
|
|
2980
|
-
# The name of the metric this quota limit applies to. The quota limits with
|
2981
|
-
#
|
2551
|
+
# The name of the metric this quota limit applies to. The quota limits with the
|
2552
|
+
# same metric will be checked together during runtime. The metric must be
|
2982
2553
|
# defined within the service config.
|
2983
2554
|
# Corresponds to the JSON property `metric`
|
2984
2555
|
# @return [String]
|
2985
2556
|
attr_accessor :metric
|
2986
2557
|
|
2987
|
-
# Name of the quota limit.
|
2988
|
-
#
|
2989
|
-
#
|
2990
|
-
# The maximum length of the limit name is 64 characters.
|
2558
|
+
# Name of the quota limit. The name must be provided, and it must be unique
|
2559
|
+
# within the service. The name can only include alphanumeric characters as well
|
2560
|
+
# as '-'. The maximum length of the limit name is 64 characters.
|
2991
2561
|
# Corresponds to the JSON property `name`
|
2992
2562
|
# @return [String]
|
2993
2563
|
attr_accessor :name
|
2994
2564
|
|
2995
|
-
# Specify the unit of the quota limit. It uses the same syntax as
|
2996
|
-
#
|
2997
|
-
#
|
2998
|
-
#
|
2999
|
-
#
|
3000
|
-
# Note: the order of unit components is insignificant.
|
3001
|
-
# The "1" at the beginning is required to follow the metric unit syntax.
|
2565
|
+
# Specify the unit of the quota limit. It uses the same syntax as Metric.unit.
|
2566
|
+
# The supported unit kinds are determined by the quota backend system. Here are
|
2567
|
+
# some examples: * "1/min/`project`" for quota per minute per project. Note: the
|
2568
|
+
# order of unit components is insignificant. The "1" at the beginning is
|
2569
|
+
# required to follow the metric unit syntax.
|
3002
2570
|
# Corresponds to the JSON property `unit`
|
3003
2571
|
# @return [String]
|
3004
2572
|
attr_accessor :unit
|
3005
2573
|
|
3006
2574
|
# Tiered limit values. You must specify this as a key:value pair, with an
|
3007
|
-
# integer value that is the maximum number of requests allowed for the
|
3008
|
-
#
|
2575
|
+
# integer value that is the maximum number of requests allowed for the specified
|
2576
|
+
# unit. Currently only STANDARD is supported.
|
3009
2577
|
# Corresponds to the JSON property `values`
|
3010
2578
|
# @return [Hash<String,Fixnum>]
|
3011
2579
|
attr_accessor :values
|
@@ -3033,15 +2601,14 @@ module Google
|
|
3033
2601
|
class Range
|
3034
2602
|
include Google::Apis::Core::Hashable
|
3035
2603
|
|
3036
|
-
# CIDR range in "10.x.x.x/y" format that is within the
|
3037
|
-
#
|
2604
|
+
# CIDR range in "10.x.x.x/y" format that is within the allocated ranges and
|
2605
|
+
# currently unused.
|
3038
2606
|
# Corresponds to the JSON property `ipCidrRange`
|
3039
2607
|
# @return [String]
|
3040
2608
|
attr_accessor :ip_cidr_range
|
3041
2609
|
|
3042
2610
|
# In the Shared VPC host project, the VPC network that's peered with the
|
3043
|
-
# consumer network. For example:
|
3044
|
-
# `projects/1234321/global/networks/host-network`
|
2611
|
+
# consumer network. For example: `projects/1234321/global/networks/host-network`
|
3045
2612
|
# Corresponds to the JSON property `network`
|
3046
2613
|
# @return [String]
|
3047
2614
|
attr_accessor :network
|
@@ -3127,15 +2694,15 @@ module Google
|
|
3127
2694
|
attr_accessor :name
|
3128
2695
|
|
3129
2696
|
# Fully-qualified URL of the VPC network in the producer host tenant project
|
3130
|
-
# that this route applies to. For example:
|
3131
|
-
#
|
2697
|
+
# that this route applies to. For example: `projects/123456/global/networks/host-
|
2698
|
+
# network`
|
3132
2699
|
# Corresponds to the JSON property `network`
|
3133
2700
|
# @return [String]
|
3134
2701
|
attr_accessor :network
|
3135
2702
|
|
3136
2703
|
# Fully-qualified URL of the gateway that should handle matching packets that
|
3137
|
-
# this route applies to. For example:
|
3138
|
-
#
|
2704
|
+
# this route applies to. For example: `projects/123456/global/gateways/default-
|
2705
|
+
# internet-gateway`
|
3139
2706
|
# Corresponds to the JSON property `nextHopGateway`
|
3140
2707
|
# @return [String]
|
3141
2708
|
attr_accessor :next_hop_gateway
|
@@ -3157,21 +2724,18 @@ module Google
|
|
3157
2724
|
class SearchRangeRequest
|
3158
2725
|
include Google::Apis::Core::Hashable
|
3159
2726
|
|
3160
|
-
# Required. The prefix length of the IP range.
|
3161
|
-
#
|
3162
|
-
#
|
3163
|
-
#
|
3164
|
-
# peered network and returned in the result.
|
2727
|
+
# Required. The prefix length of the IP range. Use usual CIDR range notation.
|
2728
|
+
# For example, '30' to find unused x.x.x.x/30 CIDR range. Actual range will be
|
2729
|
+
# determined using allocated range for the consumer peered network and returned
|
2730
|
+
# in the result.
|
3165
2731
|
# Corresponds to the JSON property `ipPrefixLength`
|
3166
2732
|
# @return [Fixnum]
|
3167
2733
|
attr_accessor :ip_prefix_length
|
3168
2734
|
|
3169
|
-
# Network name in the consumer project.
|
3170
|
-
#
|
3171
|
-
#
|
3172
|
-
#
|
3173
|
-
# `project` is a project number, as in '12345'
|
3174
|
-
# `network` is network name.
|
2735
|
+
# Network name in the consumer project. This network must have been already
|
2736
|
+
# peered with a shared VPC network using CreateConnection method. Must be in a
|
2737
|
+
# form 'projects/`project`/global/networks/`network`'. `project` is a project
|
2738
|
+
# number, as in '12345' `network` is network name.
|
3175
2739
|
# Corresponds to the JSON property `network`
|
3176
2740
|
# @return [String]
|
3177
2741
|
attr_accessor :network
|
@@ -3188,50 +2752,32 @@ module Google
|
|
3188
2752
|
end
|
3189
2753
|
|
3190
2754
|
# `Service` is the root object of Google service configuration schema. It
|
3191
|
-
# describes basic information about a service, such as the name and the
|
3192
|
-
#
|
3193
|
-
#
|
3194
|
-
#
|
3195
|
-
#
|
3196
|
-
#
|
3197
|
-
#
|
3198
|
-
#
|
3199
|
-
#
|
3200
|
-
# apis:
|
3201
|
-
# - name: google.calendar.v3.Calendar
|
3202
|
-
# authentication:
|
3203
|
-
# providers:
|
3204
|
-
# - id: google_calendar_auth
|
3205
|
-
# jwks_uri: https://www.googleapis.com/oauth2/v1/certs
|
3206
|
-
# issuer: https://securetoken.google.com
|
3207
|
-
# rules:
|
3208
|
-
# - selector: "*"
|
3209
|
-
# requirements:
|
3210
|
-
# provider_id: google_calendar_auth
|
2755
|
+
# describes basic information about a service, such as the name and the title,
|
2756
|
+
# and delegates other aspects to sub-sections. Each sub-section is either a
|
2757
|
+
# proto message or a repeated proto message that configures a specific aspect,
|
2758
|
+
# such as auth. See each proto message definition for details. Example: type:
|
2759
|
+
# google.api.Service config_version: 3 name: calendar.googleapis.com title:
|
2760
|
+
# Google Calendar API apis: - name: google.calendar.v3.Calendar authentication:
|
2761
|
+
# providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/
|
2762
|
+
# oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: "*"
|
2763
|
+
# requirements: provider_id: google_calendar_auth
|
3211
2764
|
class Service
|
3212
2765
|
include Google::Apis::Core::Hashable
|
3213
2766
|
|
3214
|
-
# A list of API interfaces exported by this service. Only the `name` field
|
3215
|
-
#
|
3216
|
-
#
|
3217
|
-
#
|
3218
|
-
#
|
2767
|
+
# A list of API interfaces exported by this service. Only the `name` field of
|
2768
|
+
# the google.protobuf.Api needs to be provided by the configuration author, as
|
2769
|
+
# the remaining fields will be derived from the IDL during the normalization
|
2770
|
+
# process. It is an error to specify an API interface here which cannot be
|
2771
|
+
# resolved against the associated IDL files.
|
3219
2772
|
# Corresponds to the JSON property `apis`
|
3220
2773
|
# @return [Array<Google::Apis::ServicenetworkingV1beta::Api>]
|
3221
2774
|
attr_accessor :apis
|
3222
2775
|
|
3223
|
-
# `Authentication` defines the authentication configuration for an API.
|
3224
|
-
#
|
3225
|
-
#
|
3226
|
-
#
|
3227
|
-
#
|
3228
|
-
# - id: google_calendar_auth
|
3229
|
-
# jwks_uri: https://www.googleapis.com/oauth2/v1/certs
|
3230
|
-
# issuer: https://securetoken.google.com
|
3231
|
-
# rules:
|
3232
|
-
# - selector: "*"
|
3233
|
-
# requirements:
|
3234
|
-
# provider_id: google_calendar_auth
|
2776
|
+
# `Authentication` defines the authentication configuration for an API. Example
|
2777
|
+
# for an API targeted for external use: name: calendar.googleapis.com
|
2778
|
+
# authentication: providers: - id: google_calendar_auth jwks_uri: https://www.
|
2779
|
+
# googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: -
|
2780
|
+
# selector: "*" requirements: provider_id: google_calendar_auth
|
3235
2781
|
# Corresponds to the JSON property `authentication`
|
3236
2782
|
# @return [Google::Apis::ServicenetworkingV1beta::Authentication]
|
3237
2783
|
attr_accessor :authentication
|
@@ -3241,211 +2787,136 @@ module Google
|
|
3241
2787
|
# @return [Google::Apis::ServicenetworkingV1beta::Backend]
|
3242
2788
|
attr_accessor :backend
|
3243
2789
|
|
3244
|
-
# Billing related configuration of the service.
|
3245
|
-
#
|
3246
|
-
#
|
3247
|
-
#
|
3248
|
-
#
|
3249
|
-
#
|
3250
|
-
#
|
3251
|
-
#
|
3252
|
-
# -
|
3253
|
-
#
|
3254
|
-
# - key:
|
3255
|
-
#
|
3256
|
-
#
|
3257
|
-
# -
|
3258
|
-
#
|
3259
|
-
# Custom label to define the city where the library branch is located
|
3260
|
-
# in.
|
3261
|
-
# - key: name
|
3262
|
-
# description: Custom label to define the name of the library branch.
|
3263
|
-
# metrics:
|
3264
|
-
# - name: library.googleapis.com/book/borrowed_count
|
3265
|
-
# metric_kind: DELTA
|
3266
|
-
# value_type: INT64
|
3267
|
-
# unit: "1"
|
3268
|
-
# billing:
|
3269
|
-
# consumer_destinations:
|
3270
|
-
# - monitored_resource: library.googleapis.com/billing_branch
|
3271
|
-
# metrics:
|
3272
|
-
# - library.googleapis.com/book/borrowed_count
|
2790
|
+
# Billing related configuration of the service. The following example shows how
|
2791
|
+
# to configure monitored resources and metrics for billing, `
|
2792
|
+
# consumer_destinations` is the only supported destination and the monitored
|
2793
|
+
# resources need at least one label key `cloud.googleapis.com/location` to
|
2794
|
+
# indicate the location of the billing usage, using different monitored
|
2795
|
+
# resources between monitoring and billing is recommended so they can be evolved
|
2796
|
+
# independently: monitored_resources: - type: library.googleapis.com/
|
2797
|
+
# billing_branch labels: - key: cloud.googleapis.com/location description: |
|
2798
|
+
# Predefined label to support billing location restriction. - key: city
|
2799
|
+
# description: | Custom label to define the city where the library branch is
|
2800
|
+
# located in. - key: name description: Custom label to define the name of the
|
2801
|
+
# library branch. metrics: - name: library.googleapis.com/book/borrowed_count
|
2802
|
+
# metric_kind: DELTA value_type: INT64 unit: "1" billing: consumer_destinations:
|
2803
|
+
# - monitored_resource: library.googleapis.com/billing_branch metrics: - library.
|
2804
|
+
# googleapis.com/book/borrowed_count
|
3273
2805
|
# Corresponds to the JSON property `billing`
|
3274
2806
|
# @return [Google::Apis::ServicenetworkingV1beta::Billing]
|
3275
2807
|
attr_accessor :billing
|
3276
2808
|
|
3277
|
-
# The semantic version of the service configuration. The config version
|
3278
|
-
#
|
3279
|
-
#
|
3280
|
-
#
|
2809
|
+
# The semantic version of the service configuration. The config version affects
|
2810
|
+
# the interpretation of the service configuration. For example, certain features
|
2811
|
+
# are enabled by default for certain config versions. The latest config version
|
2812
|
+
# is `3`.
|
3281
2813
|
# Corresponds to the JSON property `configVersion`
|
3282
2814
|
# @return [Fixnum]
|
3283
2815
|
attr_accessor :config_version
|
3284
2816
|
|
3285
|
-
# `Context` defines which contexts an API requests.
|
3286
|
-
#
|
3287
|
-
# context
|
3288
|
-
#
|
3289
|
-
#
|
3290
|
-
#
|
3291
|
-
# -
|
3292
|
-
#
|
3293
|
-
#
|
3294
|
-
#
|
3295
|
-
#
|
3296
|
-
#
|
3297
|
-
#
|
3298
|
-
# This also provides mechanism to whitelist any protobuf message extension that
|
3299
|
-
# can be sent in grpc metadata using “x-goog-ext-<extension_id>-bin” and
|
3300
|
-
# “x-goog-ext-<extension_id>-jspb” format. For example, list any service
|
3301
|
-
# specific protobuf types that can appear in grpc metadata as follows in your
|
3302
|
-
# yaml file:
|
3303
|
-
# Example:
|
3304
|
-
# context:
|
3305
|
-
# rules:
|
3306
|
-
# - selector: "google.example.library.v1.LibraryService.CreateBook"
|
3307
|
-
# allowed_request_extensions:
|
3308
|
-
# - google.foo.v1.NewExtension
|
3309
|
-
# allowed_response_extensions:
|
3310
|
-
# - google.foo.v1.NewExtension
|
3311
|
-
# You can also specify extension ID instead of fully qualified extension name
|
3312
|
-
# here.
|
2817
|
+
# `Context` defines which contexts an API requests. Example: context: rules: -
|
2818
|
+
# selector: "*" requested: - google.rpc.context.ProjectContext - google.rpc.
|
2819
|
+
# context.OriginContext The above specifies that all methods in the API request `
|
2820
|
+
# google.rpc.context.ProjectContext` and `google.rpc.context.OriginContext`.
|
2821
|
+
# Available context types are defined in package `google.rpc.context`. This also
|
2822
|
+
# provides mechanism to whitelist any protobuf message extension that can be
|
2823
|
+
# sent in grpc metadata using “x-goog-ext--bin” and “x-goog-ext--jspb” format.
|
2824
|
+
# For example, list any service specific protobuf types that can appear in grpc
|
2825
|
+
# metadata as follows in your yaml file: Example: context: rules: - selector: "
|
2826
|
+
# google.example.library.v1.LibraryService.CreateBook"
|
2827
|
+
# allowed_request_extensions: - google.foo.v1.NewExtension
|
2828
|
+
# allowed_response_extensions: - google.foo.v1.NewExtension You can also specify
|
2829
|
+
# extension ID instead of fully qualified extension name here.
|
3313
2830
|
# Corresponds to the JSON property `context`
|
3314
2831
|
# @return [Google::Apis::ServicenetworkingV1beta::Context]
|
3315
2832
|
attr_accessor :context
|
3316
2833
|
|
3317
|
-
# Selects and configures the service controller used by the service.
|
3318
|
-
#
|
3319
|
-
#
|
2834
|
+
# Selects and configures the service controller used by the service. The service
|
2835
|
+
# controller handles features like abuse, quota, billing, logging, monitoring,
|
2836
|
+
# etc.
|
3320
2837
|
# Corresponds to the JSON property `control`
|
3321
2838
|
# @return [Google::Apis::ServicenetworkingV1beta::Control]
|
3322
2839
|
attr_accessor :control
|
3323
2840
|
|
3324
|
-
# Customize service error responses.
|
3325
|
-
#
|
3326
|
-
#
|
3327
|
-
#
|
3328
|
-
# custom_error:
|
3329
|
-
# types:
|
3330
|
-
# - google.foo.v1.CustomError
|
3331
|
-
# - google.foo.v1.AnotherError
|
2841
|
+
# Customize service error responses. For example, list any service specific
|
2842
|
+
# protobuf types that can appear in error detail lists of error responses.
|
2843
|
+
# Example: custom_error: types: - google.foo.v1.CustomError - google.foo.v1.
|
2844
|
+
# AnotherError
|
3332
2845
|
# Corresponds to the JSON property `customError`
|
3333
2846
|
# @return [Google::Apis::ServicenetworkingV1beta::CustomError]
|
3334
2847
|
attr_accessor :custom_error
|
3335
2848
|
|
3336
|
-
# `Documentation` provides the information for describing a service.
|
3337
|
-
#
|
3338
|
-
#
|
3339
|
-
#
|
3340
|
-
#
|
3341
|
-
#
|
3342
|
-
#
|
3343
|
-
#
|
3344
|
-
#
|
3345
|
-
#
|
3346
|
-
#
|
3347
|
-
#
|
3348
|
-
#
|
3349
|
-
#
|
3350
|
-
#
|
3351
|
-
#
|
3352
|
-
#
|
3353
|
-
#
|
3354
|
-
#
|
3355
|
-
#
|
3356
|
-
#
|
3357
|
-
#
|
3358
|
-
#
|
3359
|
-
#
|
3360
|
-
#
|
3361
|
-
#
|
3362
|
-
# a documentation fragment is embedded.
|
3363
|
-
# Documentation from the IDL is merged with documentation defined
|
3364
|
-
# via the config at normalization time, where documentation provided
|
3365
|
-
# by config rules overrides IDL provided.
|
3366
|
-
# A number of constructs specific to the API platform are supported
|
3367
|
-
# in documentation text.
|
3368
|
-
# In order to reference a proto element, the following
|
3369
|
-
# notation can be used:
|
3370
|
-
# <pre><code>[fully.qualified.proto.name][]</code></pre>
|
3371
|
-
# To override the display text used for the link, this can be used:
|
3372
|
-
# <pre><code>[display text][fully.qualified.proto.name]</code></pre>
|
3373
|
-
# Text can be excluded from doc using the following notation:
|
3374
|
-
# <pre><code>(-- internal comment --)</code></pre>
|
3375
|
-
# A few directives are available in documentation. Note that
|
3376
|
-
# directives must appear on a single line to be properly
|
3377
|
-
# identified. The `include` directive includes a markdown file from
|
3378
|
-
# an external source:
|
3379
|
-
# <pre><code>(== include path/to/file ==)</code></pre>
|
3380
|
-
# The `resource_for` directive marks a message to be the resource of
|
3381
|
-
# a collection in REST view. If it is not specified, tools attempt
|
3382
|
-
# to infer the resource from the operations in a collection:
|
3383
|
-
# <pre><code>(== resource_for v1.shelves.books ==)</code></pre>
|
3384
|
-
# The directive `suppress_warning` does not directly affect documentation
|
3385
|
-
# and is documented together with service config validation.
|
2849
|
+
# `Documentation` provides the information for describing a service. Example:
|
2850
|
+
# documentation: summary: > The Google Calendar API gives access to most
|
2851
|
+
# calendar features. pages: - name: Overview content: (== include google/foo/
|
2852
|
+
# overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==
|
2853
|
+
# ) subpages; - name: Java content: (== include google/foo/tutorial_java.md ==)
|
2854
|
+
# rules: - selector: google.calendar.Calendar.Get description: > ... - selector:
|
2855
|
+
# google.calendar.Calendar.Put description: > ... Documentation is provided in
|
2856
|
+
# markdown syntax. In addition to standard markdown features, definition lists,
|
2857
|
+
# tables and fenced code blocks are supported. Section headers can be provided
|
2858
|
+
# and are interpreted relative to the section nesting of the context where a
|
2859
|
+
# documentation fragment is embedded. Documentation from the IDL is merged with
|
2860
|
+
# documentation defined via the config at normalization time, where
|
2861
|
+
# documentation provided by config rules overrides IDL provided. A number of
|
2862
|
+
# constructs specific to the API platform are supported in documentation text.
|
2863
|
+
# In order to reference a proto element, the following notation can be used: [
|
2864
|
+
# fully.qualified.proto.name][] To override the display text used for the link,
|
2865
|
+
# this can be used: [display text][fully.qualified.proto.name] Text can be
|
2866
|
+
# excluded from doc using the following notation: (-- internal comment --) A few
|
2867
|
+
# directives are available in documentation. Note that directives must appear on
|
2868
|
+
# a single line to be properly identified. The `include` directive includes a
|
2869
|
+
# markdown file from an external source: (== include path/to/file ==) The `
|
2870
|
+
# resource_for` directive marks a message to be the resource of a collection in
|
2871
|
+
# REST view. If it is not specified, tools attempt to infer the resource from
|
2872
|
+
# the operations in a collection: (== resource_for v1.shelves.books ==) The
|
2873
|
+
# directive `suppress_warning` does not directly affect documentation and is
|
2874
|
+
# documented together with service config validation.
|
3386
2875
|
# Corresponds to the JSON property `documentation`
|
3387
2876
|
# @return [Google::Apis::ServicenetworkingV1beta::Documentation]
|
3388
2877
|
attr_accessor :documentation
|
3389
2878
|
|
3390
|
-
# Configuration for network endpoints.
|
3391
|
-
#
|
3392
|
-
#
|
2879
|
+
# Configuration for network endpoints. If this is empty, then an endpoint with
|
2880
|
+
# the same name as the service is automatically generated to service all defined
|
2881
|
+
# APIs.
|
3393
2882
|
# Corresponds to the JSON property `endpoints`
|
3394
2883
|
# @return [Array<Google::Apis::ServicenetworkingV1beta::Endpoint>]
|
3395
2884
|
attr_accessor :endpoints
|
3396
2885
|
|
3397
|
-
# A list of all enum types included in this API service.
|
3398
|
-
#
|
3399
|
-
#
|
3400
|
-
#
|
3401
|
-
# enums:
|
3402
|
-
# - name: google.someapi.v1.SomeEnum
|
2886
|
+
# A list of all enum types included in this API service. Enums referenced
|
2887
|
+
# directly or indirectly by the `apis` are automatically included. Enums which
|
2888
|
+
# are not referenced but shall be included should be listed here by name.
|
2889
|
+
# Example: enums: - name: google.someapi.v1.SomeEnum
|
3403
2890
|
# Corresponds to the JSON property `enums`
|
3404
2891
|
# @return [Array<Google::Apis::ServicenetworkingV1beta::Enum>]
|
3405
2892
|
attr_accessor :enums
|
3406
2893
|
|
3407
2894
|
# Defines the HTTP configuration for an API service. It contains a list of
|
3408
|
-
# HttpRule, each specifying the mapping of an RPC method
|
3409
|
-
#
|
2895
|
+
# HttpRule, each specifying the mapping of an RPC method to one or more HTTP
|
2896
|
+
# REST API methods.
|
3410
2897
|
# Corresponds to the JSON property `http`
|
3411
2898
|
# @return [Google::Apis::ServicenetworkingV1beta::Http]
|
3412
2899
|
attr_accessor :http
|
3413
2900
|
|
3414
|
-
# A unique ID for a specific instance of this message, typically assigned
|
3415
|
-
#
|
3416
|
-
#
|
3417
|
-
#
|
2901
|
+
# A unique ID for a specific instance of this message, typically assigned by the
|
2902
|
+
# client for tracking purpose. Must be no longer than 63 characters and only
|
2903
|
+
# lower case letters, digits, '.', '_' and '-' are allowed. If empty, the server
|
2904
|
+
# may choose to generate one instead.
|
3418
2905
|
# Corresponds to the JSON property `id`
|
3419
2906
|
# @return [String]
|
3420
2907
|
attr_accessor :id
|
3421
2908
|
|
3422
|
-
# Logging configuration of the service.
|
3423
|
-
#
|
3424
|
-
#
|
3425
|
-
# log is sent to
|
3426
|
-
#
|
3427
|
-
#
|
3428
|
-
# -
|
3429
|
-
# labels:
|
3430
|
-
# -
|
3431
|
-
#
|
3432
|
-
#
|
3433
|
-
# description: The name of the branch.
|
3434
|
-
# logs:
|
3435
|
-
# - name: activity_history
|
3436
|
-
# labels:
|
3437
|
-
# - key: /customer_id
|
3438
|
-
# - name: purchase_history
|
3439
|
-
# logging:
|
3440
|
-
# producer_destinations:
|
3441
|
-
# - monitored_resource: library.googleapis.com/branch
|
3442
|
-
# logs:
|
3443
|
-
# - activity_history
|
3444
|
-
# - purchase_history
|
3445
|
-
# consumer_destinations:
|
3446
|
-
# - monitored_resource: library.googleapis.com/branch
|
3447
|
-
# logs:
|
3448
|
-
# - activity_history
|
2909
|
+
# Logging configuration of the service. The following example shows how to
|
2910
|
+
# configure logs to be sent to the producer and consumer projects. In the
|
2911
|
+
# example, the `activity_history` log is sent to both the producer and consumer
|
2912
|
+
# projects, whereas the `purchase_history` log is only sent to the producer
|
2913
|
+
# project. monitored_resources: - type: library.googleapis.com/branch labels: -
|
2914
|
+
# key: /city description: The city where the library branch is located in. - key:
|
2915
|
+
# /name description: The name of the branch. logs: - name: activity_history
|
2916
|
+
# labels: - key: /customer_id - name: purchase_history logging:
|
2917
|
+
# producer_destinations: - monitored_resource: library.googleapis.com/branch
|
2918
|
+
# logs: - activity_history - purchase_history consumer_destinations: -
|
2919
|
+
# monitored_resource: library.googleapis.com/branch logs: - activity_history
|
3449
2920
|
# Corresponds to the JSON property `logging`
|
3450
2921
|
# @return [Google::Apis::ServicenetworkingV1beta::Logging]
|
3451
2922
|
attr_accessor :logging
|
@@ -3460,70 +2931,41 @@ module Google
|
|
3460
2931
|
# @return [Array<Google::Apis::ServicenetworkingV1beta::MetricDescriptor>]
|
3461
2932
|
attr_accessor :metrics
|
3462
2933
|
|
3463
|
-
# Defines the monitored resources used by this service. This is required
|
3464
|
-
#
|
2934
|
+
# Defines the monitored resources used by this service. This is required by the
|
2935
|
+
# Service.monitoring and Service.logging configurations.
|
3465
2936
|
# Corresponds to the JSON property `monitoredResources`
|
3466
2937
|
# @return [Array<Google::Apis::ServicenetworkingV1beta::MonitoredResourceDescriptor>]
|
3467
2938
|
attr_accessor :monitored_resources
|
3468
2939
|
|
3469
|
-
# Monitoring configuration of the service.
|
3470
|
-
#
|
3471
|
-
#
|
3472
|
-
#
|
3473
|
-
#
|
3474
|
-
#
|
3475
|
-
#
|
3476
|
-
#
|
3477
|
-
# -
|
3478
|
-
#
|
3479
|
-
#
|
3480
|
-
#
|
3481
|
-
#
|
3482
|
-
# - key:
|
3483
|
-
#
|
3484
|
-
#
|
3485
|
-
#
|
3486
|
-
#
|
3487
|
-
#
|
3488
|
-
#
|
3489
|
-
#
|
3490
|
-
#
|
3491
|
-
# description: "The count of books that have been returned."
|
3492
|
-
# launch_stage: GA
|
3493
|
-
# metric_kind: DELTA
|
3494
|
-
# value_type: INT64
|
3495
|
-
# unit: "1"
|
3496
|
-
# labels:
|
3497
|
-
# - key: customer_id
|
3498
|
-
# description: "The id of the customer."
|
3499
|
-
# - name: library.googleapis.com/book/num_overdue
|
3500
|
-
# display_name: "Books Overdue"
|
3501
|
-
# description: "The current number of overdue books."
|
3502
|
-
# launch_stage: GA
|
3503
|
-
# metric_kind: GAUGE
|
3504
|
-
# value_type: INT64
|
3505
|
-
# unit: "1"
|
3506
|
-
# labels:
|
3507
|
-
# - key: customer_id
|
3508
|
-
# description: "The id of the customer."
|
3509
|
-
# monitoring:
|
3510
|
-
# producer_destinations:
|
3511
|
-
# - monitored_resource: library.googleapis.com/Branch
|
3512
|
-
# metrics:
|
3513
|
-
# - library.googleapis.com/book/returned_count
|
3514
|
-
# consumer_destinations:
|
3515
|
-
# - monitored_resource: library.googleapis.com/Branch
|
3516
|
-
# metrics:
|
3517
|
-
# - library.googleapis.com/book/returned_count
|
3518
|
-
# - library.googleapis.com/book/num_overdue
|
2940
|
+
# Monitoring configuration of the service. The example below shows how to
|
2941
|
+
# configure monitored resources and metrics for monitoring. In the example, a
|
2942
|
+
# monitored resource and two metrics are defined. The `library.googleapis.com/
|
2943
|
+
# book/returned_count` metric is sent to both producer and consumer projects,
|
2944
|
+
# whereas the `library.googleapis.com/book/num_overdue` metric is only sent to
|
2945
|
+
# the consumer project. monitored_resources: - type: library.googleapis.com/
|
2946
|
+
# Branch display_name: "Library Branch" description: "A branch of a library."
|
2947
|
+
# launch_stage: GA labels: - key: resource_container description: "The Cloud
|
2948
|
+
# container (ie. project id) for the Branch." - key: location description: "The
|
2949
|
+
# location of the library branch." - key: branch_id description: "The id of the
|
2950
|
+
# branch." metrics: - name: library.googleapis.com/book/returned_count
|
2951
|
+
# display_name: "Books Returned" description: "The count of books that have been
|
2952
|
+
# returned." launch_stage: GA metric_kind: DELTA value_type: INT64 unit: "1"
|
2953
|
+
# labels: - key: customer_id description: "The id of the customer." - name:
|
2954
|
+
# library.googleapis.com/book/num_overdue display_name: "Books Overdue"
|
2955
|
+
# description: "The current number of overdue books." launch_stage: GA
|
2956
|
+
# metric_kind: GAUGE value_type: INT64 unit: "1" labels: - key: customer_id
|
2957
|
+
# description: "The id of the customer." monitoring: producer_destinations: -
|
2958
|
+
# monitored_resource: library.googleapis.com/Branch metrics: - library.
|
2959
|
+
# googleapis.com/book/returned_count consumer_destinations: - monitored_resource:
|
2960
|
+
# library.googleapis.com/Branch metrics: - library.googleapis.com/book/
|
2961
|
+
# returned_count - library.googleapis.com/book/num_overdue
|
3519
2962
|
# Corresponds to the JSON property `monitoring`
|
3520
2963
|
# @return [Google::Apis::ServicenetworkingV1beta::Monitoring]
|
3521
2964
|
attr_accessor :monitoring
|
3522
2965
|
|
3523
|
-
# The service name, which is a DNS-like logical identifier for the
|
3524
|
-
#
|
3525
|
-
#
|
3526
|
-
# of the service also owns the DNS name.
|
2966
|
+
# The service name, which is a DNS-like logical identifier for the service, such
|
2967
|
+
# as `calendar.googleapis.com`. The service name typically goes through DNS
|
2968
|
+
# verification to make sure the owner of the service also owns the DNS name.
|
3527
2969
|
# Corresponds to the JSON property `name`
|
3528
2970
|
# @return [String]
|
3529
2971
|
attr_accessor :name
|
@@ -3533,46 +2975,25 @@ module Google
|
|
3533
2975
|
# @return [String]
|
3534
2976
|
attr_accessor :producer_project_id
|
3535
2977
|
|
3536
|
-
# Quota configuration helps to achieve fairness and budgeting in service
|
3537
|
-
#
|
3538
|
-
#
|
3539
|
-
#
|
3540
|
-
#
|
3541
|
-
#
|
3542
|
-
#
|
3543
|
-
#
|
3544
|
-
#
|
3545
|
-
#
|
3546
|
-
#
|
3547
|
-
# -
|
3548
|
-
#
|
3549
|
-
#
|
3550
|
-
#
|
3551
|
-
#
|
3552
|
-
#
|
3553
|
-
#
|
3554
|
-
#
|
3555
|
-
# # consuming at twice rate as the DeleteBook method.
|
3556
|
-
# metric_rules:
|
3557
|
-
# - selector: "*"
|
3558
|
-
# metric_costs:
|
3559
|
-
# library.googleapis.com/read_calls: 1
|
3560
|
-
# - selector: google.example.library.v1.LibraryService.UpdateBook
|
3561
|
-
# metric_costs:
|
3562
|
-
# library.googleapis.com/write_calls: 2
|
3563
|
-
# - selector: google.example.library.v1.LibraryService.DeleteBook
|
3564
|
-
# metric_costs:
|
3565
|
-
# library.googleapis.com/write_calls: 1
|
3566
|
-
# Corresponding Metric definition:
|
3567
|
-
# metrics:
|
3568
|
-
# - name: library.googleapis.com/read_calls
|
3569
|
-
# display_name: Read requests
|
3570
|
-
# metric_kind: DELTA
|
3571
|
-
# value_type: INT64
|
3572
|
-
# - name: library.googleapis.com/write_calls
|
3573
|
-
# display_name: Write requests
|
3574
|
-
# metric_kind: DELTA
|
3575
|
-
# value_type: INT64
|
2978
|
+
# Quota configuration helps to achieve fairness and budgeting in service usage.
|
2979
|
+
# The metric based quota configuration works this way: - The service
|
2980
|
+
# configuration defines a set of metrics. - For API calls, the quota.
|
2981
|
+
# metric_rules maps methods to metrics with corresponding costs. - The quota.
|
2982
|
+
# limits defines limits on the metrics, which will be used for quota checks at
|
2983
|
+
# runtime. An example quota configuration in yaml format: quota: limits: - name:
|
2984
|
+
# apiWriteQpsPerProject metric: library.googleapis.com/write_calls unit: "1/min/`
|
2985
|
+
# project`" # rate limit for consumer projects values: STANDARD: 10000 # The
|
2986
|
+
# metric rules bind all methods to the read_calls metric, # except for the
|
2987
|
+
# UpdateBook and DeleteBook methods. These two methods # are mapped to the
|
2988
|
+
# write_calls metric, with the UpdateBook method # consuming at twice rate as
|
2989
|
+
# the DeleteBook method. metric_rules: - selector: "*" metric_costs: library.
|
2990
|
+
# googleapis.com/read_calls: 1 - selector: google.example.library.v1.
|
2991
|
+
# LibraryService.UpdateBook metric_costs: library.googleapis.com/write_calls: 2 -
|
2992
|
+
# selector: google.example.library.v1.LibraryService.DeleteBook metric_costs:
|
2993
|
+
# library.googleapis.com/write_calls: 1 Corresponding Metric definition: metrics:
|
2994
|
+
# - name: library.googleapis.com/read_calls display_name: Read requests
|
2995
|
+
# metric_kind: DELTA value_type: INT64 - name: library.googleapis.com/
|
2996
|
+
# write_calls display_name: Write requests metric_kind: DELTA value_type: INT64
|
3576
2997
|
# Corresponds to the JSON property `quota`
|
3577
2998
|
# @return [Google::Apis::ServicenetworkingV1beta::Quota]
|
3578
2999
|
attr_accessor :quota
|
@@ -3582,20 +3003,18 @@ module Google
|
|
3582
3003
|
# @return [Google::Apis::ServicenetworkingV1beta::SourceInfo]
|
3583
3004
|
attr_accessor :source_info
|
3584
3005
|
|
3585
|
-
# ### System parameter configuration
|
3586
|
-
#
|
3587
|
-
#
|
3588
|
-
#
|
3589
|
-
# change the names of the system parameters.
|
3006
|
+
# ### System parameter configuration A system parameter is a special kind of
|
3007
|
+
# parameter defined by the API system, not by an individual API. It is typically
|
3008
|
+
# mapped to an HTTP header and/or a URL query parameter. This configuration
|
3009
|
+
# specifies which methods change the names of the system parameters.
|
3590
3010
|
# Corresponds to the JSON property `systemParameters`
|
3591
3011
|
# @return [Google::Apis::ServicenetworkingV1beta::SystemParameters]
|
3592
3012
|
attr_accessor :system_parameters
|
3593
3013
|
|
3594
|
-
# A list of all proto message types included in this API service.
|
3595
|
-
#
|
3596
|
-
#
|
3597
|
-
#
|
3598
|
-
# to define system APIs in ESF.
|
3014
|
+
# A list of all proto message types included in this API service. It serves
|
3015
|
+
# similar purpose as [google.api.Service.types], except that these types are not
|
3016
|
+
# needed by user-defined APIs. Therefore, they will not show up in the generated
|
3017
|
+
# discovery doc. This field should only be used to define system APIs in ESF.
|
3599
3018
|
# Corresponds to the JSON property `systemTypes`
|
3600
3019
|
# @return [Array<Google::Apis::ServicenetworkingV1beta::Type>]
|
3601
3020
|
attr_accessor :system_types
|
@@ -3605,12 +3024,10 @@ module Google
|
|
3605
3024
|
# @return [String]
|
3606
3025
|
attr_accessor :title
|
3607
3026
|
|
3608
|
-
# A list of all proto message types included in this API service.
|
3609
|
-
#
|
3610
|
-
#
|
3611
|
-
#
|
3612
|
-
# should be listed here by name. Example:
|
3613
|
-
# types:
|
3027
|
+
# A list of all proto message types included in this API service. Types
|
3028
|
+
# referenced directly or indirectly by the `apis` are automatically included.
|
3029
|
+
# Messages which are not referenced but shall be included, such as types used by
|
3030
|
+
# the `google.protobuf.Any` type, should be listed here by name. Example: types:
|
3614
3031
|
# - name: google.protobuf.Int32
|
3615
3032
|
# Corresponds to the JSON property `types`
|
3616
3033
|
# @return [Array<Google::Apis::ServicenetworkingV1beta::Type>]
|
@@ -3657,32 +3074,28 @@ module Google
|
|
3657
3074
|
end
|
3658
3075
|
end
|
3659
3076
|
|
3660
|
-
# The per-product per-project service identity for a service.
|
3661
|
-
#
|
3662
|
-
#
|
3663
|
-
#
|
3664
|
-
#
|
3665
|
-
# - service_account_parent: "projects/123456789"
|
3666
|
-
# display_name: "Cloud XXX Service Agent"
|
3667
|
-
# description: "Used as the identity of Cloud XXX to access resources"
|
3077
|
+
# The per-product per-project service identity for a service. Use this field to
|
3078
|
+
# configure per-product per-project service identity. Example of a service
|
3079
|
+
# identity configuration. usage: service_identity: - service_account_parent: "
|
3080
|
+
# projects/123456789" display_name: "Cloud XXX Service Agent" description: "Used
|
3081
|
+
# as the identity of Cloud XXX to access resources"
|
3668
3082
|
class ServiceIdentity
|
3669
3083
|
include Google::Apis::Core::Hashable
|
3670
3084
|
|
3671
|
-
# Optional. A user-specified opaque description of the service account.
|
3672
|
-
#
|
3085
|
+
# Optional. A user-specified opaque description of the service account. Must be
|
3086
|
+
# less than or equal to 256 UTF-8 bytes.
|
3673
3087
|
# Corresponds to the JSON property `description`
|
3674
3088
|
# @return [String]
|
3675
3089
|
attr_accessor :description
|
3676
3090
|
|
3677
|
-
# Optional. A user-specified name for the service account.
|
3678
|
-
#
|
3091
|
+
# Optional. A user-specified name for the service account. Must be less than or
|
3092
|
+
# equal to 100 UTF-8 bytes.
|
3679
3093
|
# Corresponds to the JSON property `displayName`
|
3680
3094
|
# @return [String]
|
3681
3095
|
attr_accessor :display_name
|
3682
3096
|
|
3683
|
-
# A service account project that hosts the service accounts.
|
3684
|
-
#
|
3685
|
-
# `projects/123456789`
|
3097
|
+
# A service account project that hosts the service accounts. An example name
|
3098
|
+
# would be: `projects/123456789`
|
3686
3099
|
# Corresponds to the JSON property `serviceAccountParent`
|
3687
3100
|
# @return [String]
|
3688
3101
|
attr_accessor :service_account_parent
|
@@ -3699,13 +3112,13 @@ module Google
|
|
3699
3112
|
end
|
3700
3113
|
end
|
3701
3114
|
|
3702
|
-
# `SourceContext` represents information about the source of a
|
3703
|
-
#
|
3115
|
+
# `SourceContext` represents information about the source of a protobuf element,
|
3116
|
+
# like the file in which it is defined.
|
3704
3117
|
class SourceContext
|
3705
3118
|
include Google::Apis::Core::Hashable
|
3706
3119
|
|
3707
3120
|
# The path-qualified name of the .proto file that contained the associated
|
3708
|
-
# protobuf element.
|
3121
|
+
# protobuf element. For example: `"google/protobuf/source_context.proto"`.
|
3709
3122
|
# Corresponds to the JSON property `fileName`
|
3710
3123
|
# @return [String]
|
3711
3124
|
attr_accessor :file_name
|
@@ -3739,12 +3152,12 @@ module Google
|
|
3739
3152
|
end
|
3740
3153
|
end
|
3741
3154
|
|
3742
|
-
# The `Status` type defines a logical error model that is suitable for
|
3743
|
-
#
|
3744
|
-
#
|
3745
|
-
#
|
3746
|
-
#
|
3747
|
-
#
|
3155
|
+
# The `Status` type defines a logical error model that is suitable for different
|
3156
|
+
# programming environments, including REST APIs and RPC APIs. It is used by [
|
3157
|
+
# gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
|
3158
|
+
# data: error code, error message, and error details. You can find out more
|
3159
|
+
# about this error model and how to work with it in the [API Design Guide](https:
|
3160
|
+
# //cloud.google.com/apis/design/errors).
|
3748
3161
|
class Status
|
3749
3162
|
include Google::Apis::Core::Hashable
|
3750
3163
|
|
@@ -3753,15 +3166,15 @@ module Google
|
|
3753
3166
|
# @return [Fixnum]
|
3754
3167
|
attr_accessor :code
|
3755
3168
|
|
3756
|
-
# A list of messages that carry the error details.
|
3169
|
+
# A list of messages that carry the error details. There is a common set of
|
3757
3170
|
# message types for APIs to use.
|
3758
3171
|
# Corresponds to the JSON property `details`
|
3759
3172
|
# @return [Array<Hash<String,Object>>]
|
3760
3173
|
attr_accessor :details
|
3761
3174
|
|
3762
|
-
# A developer-facing error message, which should be in English. Any
|
3763
|
-
#
|
3764
|
-
#
|
3175
|
+
# A developer-facing error message, which should be in English. Any user-facing
|
3176
|
+
# error message should be localized and sent in the google.rpc.Status.details
|
3177
|
+
# field, or localized by the client.
|
3765
3178
|
# Corresponds to the JSON property `message`
|
3766
3179
|
# @return [String]
|
3767
3180
|
attr_accessor :message
|
@@ -3788,21 +3201,19 @@ module Google
|
|
3788
3201
|
# @return [String]
|
3789
3202
|
attr_accessor :ip_cidr_range
|
3790
3203
|
|
3791
|
-
# Subnetwork name.
|
3792
|
-
# See https://cloud.google.com/compute/docs/vpc/
|
3204
|
+
# Subnetwork name. See https://cloud.google.com/compute/docs/vpc/
|
3793
3205
|
# Corresponds to the JSON property `name`
|
3794
3206
|
# @return [String]
|
3795
3207
|
attr_accessor :name
|
3796
3208
|
|
3797
3209
|
# In the Shared VPC host project, the VPC network that's peered with the
|
3798
|
-
# consumer network. For example:
|
3799
|
-
# `projects/1234321/global/networks/host-network`
|
3210
|
+
# consumer network. For example: `projects/1234321/global/networks/host-network`
|
3800
3211
|
# Corresponds to the JSON property `network`
|
3801
3212
|
# @return [String]
|
3802
3213
|
attr_accessor :network
|
3803
3214
|
|
3804
|
-
# This is a discovered subnet that is not within the current consumer
|
3805
|
-
#
|
3215
|
+
# This is a discovered subnet that is not within the current consumer allocated
|
3216
|
+
# ranges.
|
3806
3217
|
# Corresponds to the JSON property `outsideAllocation`
|
3807
3218
|
# @return [Boolean]
|
3808
3219
|
attr_accessor :outside_allocation
|
@@ -3827,8 +3238,7 @@ module Google
|
|
3827
3238
|
class SystemParameter
|
3828
3239
|
include Google::Apis::Core::Hashable
|
3829
3240
|
|
3830
|
-
# Define the HTTP header name to use for the parameter. It is case
|
3831
|
-
# insensitive.
|
3241
|
+
# Define the HTTP header name to use for the parameter. It is case insensitive.
|
3832
3242
|
# Corresponds to the JSON property `httpHeader`
|
3833
3243
|
# @return [String]
|
3834
3244
|
attr_accessor :http_header
|
@@ -3856,23 +3266,20 @@ module Google
|
|
3856
3266
|
end
|
3857
3267
|
end
|
3858
3268
|
|
3859
|
-
# Define a system parameter rule mapping system parameter definitions to
|
3860
|
-
# methods.
|
3269
|
+
# Define a system parameter rule mapping system parameter definitions to methods.
|
3861
3270
|
class SystemParameterRule
|
3862
3271
|
include Google::Apis::Core::Hashable
|
3863
3272
|
|
3864
|
-
# Define parameters. Multiple names may be defined for a parameter.
|
3865
|
-
#
|
3866
|
-
#
|
3867
|
-
#
|
3868
|
-
# parameter-dependent.
|
3273
|
+
# Define parameters. Multiple names may be defined for a parameter. For a given
|
3274
|
+
# method call, only one of them should be used. If multiple names are used the
|
3275
|
+
# behavior is implementation-dependent. If none of the specified names are
|
3276
|
+
# present the behavior is parameter-dependent.
|
3869
3277
|
# Corresponds to the JSON property `parameters`
|
3870
3278
|
# @return [Array<Google::Apis::ServicenetworkingV1beta::SystemParameter>]
|
3871
3279
|
attr_accessor :parameters
|
3872
3280
|
|
3873
3281
|
# Selects the methods to which this rule applies. Use '*' to indicate all
|
3874
|
-
# methods in all APIs.
|
3875
|
-
# Refer to selector for syntax details.
|
3282
|
+
# methods in all APIs. Refer to selector for syntax details.
|
3876
3283
|
# Corresponds to the JSON property `selector`
|
3877
3284
|
# @return [String]
|
3878
3285
|
attr_accessor :selector
|
@@ -3888,36 +3295,23 @@ module Google
|
|
3888
3295
|
end
|
3889
3296
|
end
|
3890
3297
|
|
3891
|
-
# ### System parameter configuration
|
3892
|
-
#
|
3893
|
-
#
|
3894
|
-
#
|
3895
|
-
# change the names of the system parameters.
|
3298
|
+
# ### System parameter configuration A system parameter is a special kind of
|
3299
|
+
# parameter defined by the API system, not by an individual API. It is typically
|
3300
|
+
# mapped to an HTTP header and/or a URL query parameter. This configuration
|
3301
|
+
# specifies which methods change the names of the system parameters.
|
3896
3302
|
class SystemParameters
|
3897
3303
|
include Google::Apis::Core::Hashable
|
3898
3304
|
|
3899
|
-
# Define system parameters.
|
3900
|
-
#
|
3901
|
-
#
|
3902
|
-
#
|
3903
|
-
#
|
3904
|
-
# Example: define api key for
|
3905
|
-
# system_parameters
|
3906
|
-
#
|
3907
|
-
# -
|
3908
|
-
#
|
3909
|
-
# - name: api_key
|
3910
|
-
# url_query_parameter: api_key
|
3911
|
-
# Example: define 2 api key names for a specific method.
|
3912
|
-
# system_parameters
|
3913
|
-
# rules:
|
3914
|
-
# - selector: "/ListShelves"
|
3915
|
-
# parameters:
|
3916
|
-
# - name: api_key
|
3917
|
-
# http_header: Api-Key1
|
3918
|
-
# - name: api_key
|
3919
|
-
# http_header: Api-Key2
|
3920
|
-
# **NOTE:** All service configuration rules follow "last one wins" order.
|
3305
|
+
# Define system parameters. The parameters defined here will override the
|
3306
|
+
# default parameters implemented by the system. If this field is missing from
|
3307
|
+
# the service config, default system parameters will be used. Default system
|
3308
|
+
# parameters and names is implementation-dependent. Example: define api key for
|
3309
|
+
# all methods system_parameters rules: - selector: "*" parameters: - name:
|
3310
|
+
# api_key url_query_parameter: api_key Example: define 2 api key names for a
|
3311
|
+
# specific method. system_parameters rules: - selector: "/ListShelves"
|
3312
|
+
# parameters: - name: api_key http_header: Api-Key1 - name: api_key http_header:
|
3313
|
+
# Api-Key2 **NOTE:** All service configuration rules follow "last one wins"
|
3314
|
+
# order.
|
3921
3315
|
# Corresponds to the JSON property `rules`
|
3922
3316
|
# @return [Array<Google::Apis::ServicenetworkingV1beta::SystemParameterRule>]
|
3923
3317
|
attr_accessor :rules
|
@@ -3956,8 +3350,8 @@ module Google
|
|
3956
3350
|
# @return [Array<Google::Apis::ServicenetworkingV1beta::Option>]
|
3957
3351
|
attr_accessor :options
|
3958
3352
|
|
3959
|
-
# `SourceContext` represents information about the source of a
|
3960
|
-
#
|
3353
|
+
# `SourceContext` represents information about the source of a protobuf element,
|
3354
|
+
# like the file in which it is defined.
|
3961
3355
|
# Corresponds to the JSON property `sourceContext`
|
3962
3356
|
# @return [Google::Apis::ServicenetworkingV1beta::SourceContext]
|
3963
3357
|
attr_accessor :source_context
|
@@ -4001,37 +3395,33 @@ module Google
|
|
4001
3395
|
include Google::Apis::Core::Hashable
|
4002
3396
|
|
4003
3397
|
# The full resource name of a channel used for sending notifications to the
|
4004
|
-
# service producer.
|
4005
|
-
#
|
4006
|
-
#
|
4007
|
-
#
|
4008
|
-
#
|
4009
|
-
# documented in https://cloud.google.com/pubsub/docs/overview.
|
3398
|
+
# service producer. Google Service Management currently only supports [Google
|
3399
|
+
# Cloud Pub/Sub](https://cloud.google.com/pubsub) as a notification channel. To
|
3400
|
+
# use Google Cloud Pub/Sub as the channel, this must be the name of a Cloud Pub/
|
3401
|
+
# Sub topic that uses the Cloud Pub/Sub topic name format documented in https://
|
3402
|
+
# cloud.google.com/pubsub/docs/overview.
|
4010
3403
|
# Corresponds to the JSON property `producerNotificationChannel`
|
4011
3404
|
# @return [String]
|
4012
3405
|
attr_accessor :producer_notification_channel
|
4013
3406
|
|
4014
3407
|
# Requirements that must be satisfied before a consumer project can use the
|
4015
|
-
# service. Each requirement is of the form
|
4016
|
-
#
|
3408
|
+
# service. Each requirement is of the form /; for example 'serviceusage.
|
3409
|
+
# googleapis.com/billing-enabled'.
|
4017
3410
|
# Corresponds to the JSON property `requirements`
|
4018
3411
|
# @return [Array<String>]
|
4019
3412
|
attr_accessor :requirements
|
4020
3413
|
|
4021
|
-
# A list of usage rules that apply to individual API methods.
|
4022
|
-
#
|
3414
|
+
# A list of usage rules that apply to individual API methods. **NOTE:** All
|
3415
|
+
# service configuration rules follow "last one wins" order.
|
4023
3416
|
# Corresponds to the JSON property `rules`
|
4024
3417
|
# @return [Array<Google::Apis::ServicenetworkingV1beta::UsageRule>]
|
4025
3418
|
attr_accessor :rules
|
4026
3419
|
|
4027
|
-
# The per-product per-project service identity for a service.
|
4028
|
-
#
|
4029
|
-
#
|
4030
|
-
#
|
4031
|
-
#
|
4032
|
-
# - service_account_parent: "projects/123456789"
|
4033
|
-
# display_name: "Cloud XXX Service Agent"
|
4034
|
-
# description: "Used as the identity of Cloud XXX to access resources"
|
3420
|
+
# The per-product per-project service identity for a service. Use this field to
|
3421
|
+
# configure per-product per-project service identity. Example of a service
|
3422
|
+
# identity configuration. usage: service_identity: - service_account_parent: "
|
3423
|
+
# projects/123456789" display_name: "Cloud XXX Service Agent" description: "Used
|
3424
|
+
# as the identity of Cloud XXX to access resources"
|
4035
3425
|
# Corresponds to the JSON property `serviceIdentity`
|
4036
3426
|
# @return [Google::Apis::ServicenetworkingV1beta::ServiceIdentity]
|
4037
3427
|
attr_accessor :service_identity
|
@@ -4049,45 +3439,36 @@ module Google
|
|
4049
3439
|
end
|
4050
3440
|
end
|
4051
3441
|
|
4052
|
-
# Usage configuration rules for the service.
|
4053
|
-
#
|
4054
|
-
#
|
4055
|
-
#
|
4056
|
-
#
|
4057
|
-
#
|
4058
|
-
#
|
4059
|
-
#
|
4060
|
-
#
|
4061
|
-
#
|
4062
|
-
# rules:
|
4063
|
-
# - selector: "*"
|
4064
|
-
# allow_unregistered_calls: true
|
4065
|
-
# Example of a method that wants to allow unregistered calls.
|
4066
|
-
# usage:
|
4067
|
-
# rules:
|
4068
|
-
# - selector: "google.example.library.v1.LibraryService.CreateBook"
|
4069
|
-
# allow_unregistered_calls: true
|
3442
|
+
# Usage configuration rules for the service. NOTE: Under development. Use this
|
3443
|
+
# rule to configure unregistered calls for the service. Unregistered calls are
|
3444
|
+
# calls that do not contain consumer project identity. (Example: calls that do
|
3445
|
+
# not contain an API key). By default, API methods do not allow unregistered
|
3446
|
+
# calls, and each method call must be identified by a consumer project identity.
|
3447
|
+
# Use this rule to allow/disallow unregistered calls. Example of an API that
|
3448
|
+
# wants to allow unregistered calls for entire service. usage: rules: - selector:
|
3449
|
+
# "*" allow_unregistered_calls: true Example of a method that wants to allow
|
3450
|
+
# unregistered calls. usage: rules: - selector: "google.example.library.v1.
|
3451
|
+
# LibraryService.CreateBook" allow_unregistered_calls: true
|
4070
3452
|
class UsageRule
|
4071
3453
|
include Google::Apis::Core::Hashable
|
4072
3454
|
|
4073
|
-
# If true, the selected method allows unregistered calls, e.g. calls
|
4074
|
-
#
|
3455
|
+
# If true, the selected method allows unregistered calls, e.g. calls that don't
|
3456
|
+
# identify any user or application.
|
4075
3457
|
# Corresponds to the JSON property `allowUnregisteredCalls`
|
4076
3458
|
# @return [Boolean]
|
4077
3459
|
attr_accessor :allow_unregistered_calls
|
4078
3460
|
alias_method :allow_unregistered_calls?, :allow_unregistered_calls
|
4079
3461
|
|
4080
3462
|
# Selects the methods to which this rule applies. Use '*' to indicate all
|
4081
|
-
# methods in all APIs.
|
4082
|
-
# Refer to selector for syntax details.
|
3463
|
+
# methods in all APIs. Refer to selector for syntax details.
|
4083
3464
|
# Corresponds to the JSON property `selector`
|
4084
3465
|
# @return [String]
|
4085
3466
|
attr_accessor :selector
|
4086
3467
|
|
4087
|
-
# If true, the selected method should skip service control and the control
|
4088
|
-
#
|
4089
|
-
#
|
4090
|
-
#
|
3468
|
+
# If true, the selected method should skip service control and the control plane
|
3469
|
+
# features, such as quota and billing, will not be available. This flag is used
|
3470
|
+
# by Google Cloud Endpoints to bypass checks for internal methods, such as
|
3471
|
+
# service health check methods.
|
4091
3472
|
# Corresponds to the JSON property `skipServiceControl`
|
4092
3473
|
# @return [Boolean]
|
4093
3474
|
attr_accessor :skip_service_control
|