google-api-client 0.42.0 → 0.43.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +275 -0
- data/generated/google/apis/abusiveexperiencereport_v1/classes.rb +8 -13
- data/generated/google/apis/abusiveexperiencereport_v1/service.rb +2 -3
- data/generated/google/apis/abusiveexperiencereport_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/accessapproval_v1.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/adexchangebuyer2_v2beta1.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/adexperiencereport_v1.rb +1 -1
- data/generated/google/apis/admob_v1/classes.rb +139 -268
- data/generated/google/apis/admob_v1/service.rb +11 -13
- data/generated/google/apis/admob_v1.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/alertcenter_v1beta1.rb +1 -1
- data/generated/google/apis/analyticsreporting_v4/classes.rb +315 -399
- data/generated/google/apis/analyticsreporting_v4.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/androiddeviceprovisioning_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/androidenterprise_v1.rb +1 -1
- data/generated/google/apis/androidmanagement_v1.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/androidpublisher_v3.rb +1 -1
- data/generated/google/apis/apigee_v1/classes.rb +739 -1192
- data/generated/google/apis/apigee_v1/representations.rb +1 -2
- data/generated/google/apis/apigee_v1/service.rb +885 -1126
- data/generated/google/apis/apigee_v1.rb +6 -7
- data/generated/google/apis/appengine_v1/service.rb +6 -3
- data/generated/google/apis/appengine_v1.rb +1 -1
- data/generated/google/apis/appengine_v1beta/service.rb +6 -2
- data/generated/google/apis/appengine_v1beta.rb +1 -1
- data/generated/google/apis/appsmarket_v2.rb +1 -1
- data/generated/google/apis/bigquery_v2/classes.rb +198 -3
- data/generated/google/apis/bigquery_v2/representations.rb +70 -0
- data/generated/google/apis/bigquery_v2.rb +1 -1
- data/generated/google/apis/bigtableadmin_v1/classes.rb +267 -0
- data/generated/google/apis/bigtableadmin_v1/representations.rb +100 -0
- data/generated/google/apis/bigtableadmin_v1.rb +1 -1
- data/generated/google/apis/bigtableadmin_v2/classes.rb +355 -0
- data/generated/google/apis/bigtableadmin_v2/representations.rb +146 -0
- data/generated/google/apis/bigtableadmin_v2/service.rb +298 -0
- data/generated/google/apis/bigtableadmin_v2.rb +1 -1
- data/generated/google/apis/billingbudgets_v1beta1/classes.rb +103 -109
- data/generated/google/apis/billingbudgets_v1beta1/representations.rb +1 -0
- data/generated/google/apis/billingbudgets_v1beta1/service.rb +30 -33
- data/generated/google/apis/billingbudgets_v1beta1.rb +1 -1
- 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_v2.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/blogger_v3.rb +2 -3
- data/generated/google/apis/books_v1/classes.rb +140 -159
- data/generated/google/apis/books_v1/service.rb +47 -49
- data/generated/google/apis/books_v1.rb +1 -1
- data/generated/google/apis/chat_v1/classes.rb +130 -0
- data/generated/google/apis/chat_v1/representations.rb +63 -0
- data/generated/google/apis/chat_v1/service.rb +71 -0
- data/generated/google/apis/chat_v1.rb +1 -1
- data/generated/google/apis/chromeuxreport_v1/classes.rb +68 -57
- data/generated/google/apis/chromeuxreport_v1/representations.rb +2 -0
- data/generated/google/apis/chromeuxreport_v1.rb +1 -1
- data/generated/google/apis/classroom_v1/classes.rb +250 -365
- data/generated/google/apis/classroom_v1/service.rb +643 -899
- data/generated/google/apis/classroom_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_v1.rb +1 -1
- data/generated/google/apis/cloudasset_v1beta1/classes.rb +3 -1
- data/generated/google/apis/cloudasset_v1beta1.rb +1 -1
- data/generated/google/apis/cloudasset_v1p4beta1.rb +1 -1
- data/generated/google/apis/cloudasset_v1p5beta1/classes.rb +1539 -0
- data/generated/google/apis/cloudasset_v1p5beta1/representations.rb +399 -0
- data/generated/google/apis/cloudasset_v1p5beta1/service.rb +129 -0
- data/generated/google/apis/cloudasset_v1p5beta1.rb +34 -0
- data/generated/google/apis/cloudbuild_v1/classes.rb +1 -1
- data/generated/google/apis/cloudbuild_v1.rb +1 -1
- data/generated/google/apis/cloudbuild_v1alpha1.rb +1 -1
- data/generated/google/apis/cloudbuild_v1alpha2.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/clouderrorreporting_v1beta1.rb +1 -1
- data/generated/google/apis/cloudfunctions_v1/classes.rb +0 -45
- data/generated/google/apis/cloudfunctions_v1/representations.rb +0 -17
- data/generated/google/apis/cloudfunctions_v1.rb +1 -1
- data/generated/google/apis/cloudidentity_v1beta1/classes.rb +25 -0
- data/generated/google/apis/cloudidentity_v1beta1/representations.rb +15 -0
- data/generated/google/apis/cloudidentity_v1beta1.rb +1 -1
- data/generated/google/apis/cloudresourcemanager_v1/classes.rb +503 -754
- data/generated/google/apis/cloudresourcemanager_v1/service.rb +198 -249
- data/generated/google/apis/cloudresourcemanager_v1.rb +1 -1
- data/generated/google/apis/cloudresourcemanager_v1beta1/classes.rb +258 -429
- data/generated/google/apis/cloudresourcemanager_v1beta1/service.rb +136 -178
- data/generated/google/apis/cloudresourcemanager_v1beta1.rb +1 -1
- data/generated/google/apis/cloudresourcemanager_v2/classes.rb +258 -414
- data/generated/google/apis/cloudresourcemanager_v2/service.rb +96 -129
- data/generated/google/apis/cloudresourcemanager_v2.rb +1 -1
- data/generated/google/apis/cloudresourcemanager_v2beta1/classes.rb +258 -414
- data/generated/google/apis/cloudresourcemanager_v2beta1/service.rb +96 -129
- data/generated/google/apis/cloudresourcemanager_v2beta1.rb +1 -1
- data/generated/google/apis/cloudscheduler_v1/classes.rb +16 -5
- data/generated/google/apis/cloudscheduler_v1/representations.rb +1 -0
- data/generated/google/apis/cloudscheduler_v1.rb +1 -1
- data/generated/google/apis/cloudscheduler_v1beta1/classes.rb +16 -5
- data/generated/google/apis/cloudscheduler_v1beta1/representations.rb +1 -0
- data/generated/google/apis/cloudscheduler_v1beta1.rb +1 -1
- data/generated/google/apis/cloudsearch_v1/classes.rb +1 -2
- data/generated/google/apis/cloudsearch_v1.rb +1 -1
- data/generated/google/apis/cloudshell_v1/classes.rb +2 -2
- data/generated/google/apis/cloudshell_v1.rb +1 -1
- data/generated/google/apis/cloudshell_v1alpha1/classes.rb +8 -5
- data/generated/google/apis/cloudshell_v1alpha1.rb +1 -1
- data/generated/google/apis/cloudtrace_v1/classes.rb +2 -3
- data/generated/google/apis/cloudtrace_v1/service.rb +1 -7
- data/generated/google/apis/cloudtrace_v1.rb +1 -1
- data/generated/google/apis/cloudtrace_v2/classes.rb +6 -5
- data/generated/google/apis/cloudtrace_v2/service.rb +3 -6
- data/generated/google/apis/cloudtrace_v2.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_alpha.rb +1 -1
- data/generated/google/apis/compute_beta/classes.rb +318 -14
- data/generated/google/apis/compute_beta/representations.rb +92 -0
- data/generated/google/apis/compute_beta/service.rb +272 -7
- data/generated/google/apis/compute_beta.rb +1 -1
- data/generated/google/apis/compute_v1/classes.rb +344 -42
- data/generated/google/apis/compute_v1/representations.rb +108 -15
- data/generated/google/apis/compute_v1/service.rb +320 -19
- data/generated/google/apis/compute_v1.rb +1 -1
- data/generated/google/apis/container_v1/classes.rb +35 -0
- data/generated/google/apis/container_v1/representations.rb +16 -0
- data/generated/google/apis/container_v1.rb +1 -1
- data/generated/google/apis/container_v1beta1/classes.rb +15 -0
- data/generated/google/apis/container_v1beta1/representations.rb +2 -0
- data/generated/google/apis/container_v1beta1.rb +1 -1
- data/generated/google/apis/content_v2/classes.rb +17 -2
- data/generated/google/apis/content_v2/representations.rb +1 -0
- data/generated/google/apis/content_v2.rb +1 -1
- data/generated/google/apis/content_v2_1/classes.rb +19 -4
- data/generated/google/apis/content_v2_1/representations.rb +1 -0
- data/generated/google/apis/content_v2_1.rb +1 -1
- data/generated/google/apis/customsearch_v1/classes.rb +303 -488
- data/generated/google/apis/customsearch_v1/service.rb +186 -333
- data/generated/google/apis/customsearch_v1.rb +1 -1
- data/generated/google/apis/datacatalog_v1beta1/classes.rb +6 -3
- data/generated/google/apis/datacatalog_v1beta1.rb +1 -1
- data/generated/google/apis/dataflow_v1b3/classes.rb +2 -1
- data/generated/google/apis/dataflow_v1b3/service.rb +2 -2
- data/generated/google/apis/dataflow_v1b3.rb +1 -1
- data/generated/google/apis/datafusion_v1/classes.rb +1154 -0
- data/generated/google/apis/{cloudfunctions_v1beta2 → datafusion_v1}/representations.rb +138 -94
- data/generated/google/apis/datafusion_v1/service.rb +680 -0
- data/generated/google/apis/datafusion_v1.rb +43 -0
- data/generated/google/apis/dataproc_v1/classes.rb +201 -325
- data/generated/google/apis/dataproc_v1/service.rb +134 -168
- data/generated/google/apis/dataproc_v1.rb +1 -1
- data/generated/google/apis/dataproc_v1beta2/classes.rb +207 -326
- data/generated/google/apis/dataproc_v1beta2/service.rb +137 -192
- data/generated/google/apis/dataproc_v1beta2.rb +1 -1
- data/generated/google/apis/datastore_v1/classes.rb +1 -1
- data/generated/google/apis/datastore_v1.rb +1 -1
- data/generated/google/apis/deploymentmanager_alpha.rb +1 -1
- data/generated/google/apis/deploymentmanager_v2.rb +1 -1
- data/generated/google/apis/deploymentmanager_v2beta.rb +1 -1
- data/generated/google/apis/dfareporting_v3_4/classes.rb +421 -0
- data/generated/google/apis/dfareporting_v3_4/representations.rb +182 -0
- data/generated/google/apis/dfareporting_v3_4.rb +1 -1
- data/generated/google/apis/dialogflow_v2/classes.rb +1301 -1539
- data/generated/google/apis/dialogflow_v2/representations.rb +15 -0
- data/generated/google/apis/dialogflow_v2/service.rb +324 -444
- data/generated/google/apis/dialogflow_v2.rb +1 -1
- data/generated/google/apis/dialogflow_v2beta1/classes.rb +1379 -1619
- data/generated/google/apis/dialogflow_v2beta1/representations.rb +15 -0
- data/generated/google/apis/dialogflow_v2beta1/service.rb +742 -990
- data/generated/google/apis/dialogflow_v2beta1.rb +1 -1
- data/generated/google/apis/displayvideo_v1/classes.rb +1775 -1731
- data/generated/google/apis/displayvideo_v1/representations.rb +300 -0
- data/generated/google/apis/displayvideo_v1/service.rb +1277 -925
- data/generated/google/apis/displayvideo_v1.rb +7 -1
- data/generated/google/apis/dlp_v2/classes.rb +10 -6
- data/generated/google/apis/dlp_v2.rb +1 -1
- data/generated/google/apis/dns_v1/classes.rb +7 -7
- data/generated/google/apis/dns_v1.rb +1 -1
- data/generated/google/apis/dns_v1beta2/classes.rb +7 -7
- data/generated/google/apis/dns_v1beta2.rb +1 -1
- data/generated/google/apis/dns_v2beta1/classes.rb +313 -162
- data/generated/google/apis/dns_v2beta1/service.rb +247 -180
- data/generated/google/apis/dns_v2beta1.rb +4 -4
- data/generated/google/apis/domainsrdap_v1/classes.rb +42 -69
- data/generated/google/apis/domainsrdap_v1/service.rb +16 -16
- data/generated/google/apis/domainsrdap_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.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/doubleclickbidmanager_v1_1.rb +1 -1
- data/generated/google/apis/doubleclicksearch_v2/classes.rb +109 -126
- data/generated/google/apis/doubleclicksearch_v2/service.rb +3 -4
- data/generated/google/apis/doubleclicksearch_v2.rb +1 -1
- data/generated/google/apis/drive_v2/classes.rb +68 -2
- data/generated/google/apis/drive_v2/representations.rb +22 -0
- data/generated/google/apis/drive_v2/service.rb +23 -10
- data/generated/google/apis/drive_v2.rb +1 -1
- data/generated/google/apis/drive_v3/classes.rb +73 -2
- data/generated/google/apis/drive_v3/representations.rb +23 -0
- data/generated/google/apis/drive_v3/service.rb +8 -5
- data/generated/google/apis/drive_v3.rb +1 -1
- data/generated/google/apis/driveactivity_v2/classes.rb +55 -68
- data/generated/google/apis/driveactivity_v2.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/factchecktools_v1alpha1.rb +1 -1
- data/generated/google/apis/fcm_v1/classes.rb +245 -393
- data/generated/google/apis/fcm_v1/service.rb +5 -6
- data/generated/google/apis/fcm_v1.rb +1 -1
- data/generated/google/apis/firebase_v1beta1/classes.rb +313 -351
- data/generated/google/apis/firebase_v1beta1/representations.rb +1 -0
- data/generated/google/apis/firebase_v1beta1/service.rb +356 -420
- data/generated/google/apis/firebase_v1beta1.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/firebasedynamiclinks_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_v1.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/firebasehosting_v1beta1.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_v1.rb +1 -1
- data/generated/google/apis/firebaseml_v1beta2/classes.rb +67 -68
- data/generated/google/apis/firebaseml_v1beta2/representations.rb +1 -0
- data/generated/google/apis/firebaseml_v1beta2/service.rb +16 -18
- data/generated/google/apis/firebaseml_v1beta2.rb +1 -1
- data/generated/google/apis/firestore_v1/classes.rb +152 -0
- data/generated/google/apis/firestore_v1/representations.rb +63 -0
- data/generated/google/apis/firestore_v1/service.rb +78 -0
- data/generated/google/apis/firestore_v1.rb +1 -1
- data/generated/google/apis/firestore_v1beta1/classes.rb +152 -0
- data/generated/google/apis/firestore_v1beta1/representations.rb +63 -0
- data/generated/google/apis/firestore_v1beta1/service.rb +78 -0
- data/generated/google/apis/firestore_v1beta1.rb +1 -1
- data/generated/google/apis/games_configuration_v1configuration/service.rb +2 -2
- data/generated/google/apis/games_configuration_v1configuration.rb +1 -1
- data/generated/google/apis/games_management_v1management/service.rb +2 -2
- data/generated/google/apis/games_management_v1management.rb +1 -1
- data/generated/google/apis/games_v1/classes.rb +1 -1
- data/generated/google/apis/games_v1/service.rb +2 -2
- data/generated/google/apis/games_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_v1.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/gameservices_v1beta.rb +1 -1
- data/generated/google/apis/genomics_v1.rb +1 -1
- data/generated/google/apis/genomics_v1alpha2.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/genomics_v2alpha1.rb +1 -1
- data/generated/google/apis/gmail_v1/classes.rb +216 -269
- data/generated/google/apis/gmail_v1/service.rb +260 -288
- data/generated/google/apis/gmail_v1.rb +3 -3
- data/generated/google/apis/gmailpostmastertools_v1beta1/classes.rb +37 -42
- data/generated/google/apis/gmailpostmastertools_v1beta1/service.rb +34 -40
- data/generated/google/apis/gmailpostmastertools_v1beta1.rb +4 -1
- data/generated/google/apis/healthcare_v1/service.rb +72 -13
- data/generated/google/apis/healthcare_v1.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 +146 -16
- data/generated/google/apis/healthcare_v1beta1.rb +1 -1
- data/generated/google/apis/iam_v1/classes.rb +22 -3
- data/generated/google/apis/iam_v1/service.rb +18 -6
- data/generated/google/apis/iam_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_v1.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_v1beta1.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/language_v1beta2.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/libraryagent_v1.rb +1 -1
- data/generated/google/apis/logging_v2/classes.rb +6 -6
- data/generated/google/apis/logging_v2.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_v1.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_v1alpha1.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/managedidentities_v1beta1.rb +1 -1
- data/generated/google/apis/memcache_v1/classes.rb +1157 -0
- data/generated/google/apis/memcache_v1/representations.rb +471 -0
- data/generated/google/apis/{cloudfunctions_v1beta2 → memcache_v1}/service.rb +268 -196
- data/generated/google/apis/{cloudfunctions_v1beta2.rb → memcache_v1.rb} +10 -9
- data/generated/google/apis/memcache_v1beta2/classes.rb +42 -503
- data/generated/google/apis/memcache_v1beta2/representations.rb +9 -110
- data/generated/google/apis/memcache_v1beta2/service.rb +0 -119
- data/generated/google/apis/memcache_v1beta2.rb +1 -1
- data/generated/google/apis/ml_v1/classes.rb +17 -11
- data/generated/google/apis/ml_v1.rb +1 -1
- data/generated/google/apis/monitoring_v1/classes.rb +14 -12
- data/generated/google/apis/monitoring_v1.rb +1 -1
- data/generated/google/apis/monitoring_v3/classes.rb +87 -45
- data/generated/google/apis/monitoring_v3/representations.rb +2 -0
- data/generated/google/apis/monitoring_v3/service.rb +5 -4
- data/generated/google/apis/monitoring_v3.rb +1 -1
- data/generated/google/apis/networkmanagement_v1/classes.rb +6 -6
- data/generated/google/apis/networkmanagement_v1.rb +1 -1
- data/generated/google/apis/networkmanagement_v1beta1/classes.rb +6 -6
- data/generated/google/apis/networkmanagement_v1beta1.rb +1 -1
- data/generated/google/apis/osconfig_v1/classes.rb +798 -2
- data/generated/google/apis/osconfig_v1/representations.rb +372 -0
- data/generated/google/apis/osconfig_v1.rb +1 -1
- data/generated/google/apis/osconfig_v1beta/classes.rb +77 -2
- data/generated/google/apis/osconfig_v1beta/representations.rb +35 -0
- data/generated/google/apis/osconfig_v1beta.rb +1 -1
- data/generated/google/apis/pagespeedonline_v5.rb +1 -1
- data/generated/google/apis/people_v1/classes.rb +382 -401
- data/generated/google/apis/people_v1/representations.rb +57 -0
- data/generated/google/apis/people_v1/service.rb +169 -385
- data/generated/google/apis/people_v1.rb +1 -1
- data/generated/google/apis/playcustomapp_v1/classes.rb +2 -2
- data/generated/google/apis/playcustomapp_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_v1.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/policytroubleshooter_v1beta.rb +1 -1
- data/generated/google/apis/prod_tt_sasportal_v1alpha1/classes.rb +122 -219
- data/generated/google/apis/prod_tt_sasportal_v1alpha1/representations.rb +0 -32
- data/generated/google/apis/prod_tt_sasportal_v1alpha1/service.rb +38 -526
- data/generated/google/apis/prod_tt_sasportal_v1alpha1.rb +1 -1
- data/generated/google/apis/pubsub_v1/classes.rb +21 -0
- data/generated/google/apis/pubsub_v1/representations.rb +2 -0
- data/generated/google/apis/pubsub_v1.rb +1 -1
- data/generated/google/apis/realtimebidding_v1/classes.rb +198 -291
- data/generated/google/apis/realtimebidding_v1/service.rb +98 -135
- data/generated/google/apis/realtimebidding_v1.rb +1 -4
- data/generated/google/apis/recommendationengine_v1beta1/classes.rb +2017 -0
- data/generated/google/apis/recommendationengine_v1beta1/representations.rb +848 -0
- data/generated/google/apis/recommendationengine_v1beta1/service.rb +990 -0
- data/generated/google/apis/recommendationengine_v1beta1.rb +36 -0
- 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_v1.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/recommender_v1beta1.rb +1 -1
- data/generated/google/apis/redis_v1/classes.rb +397 -0
- data/generated/google/apis/redis_v1/representations.rb +139 -0
- data/generated/google/apis/redis_v1.rb +1 -1
- data/generated/google/apis/redis_v1beta1/classes.rb +397 -0
- data/generated/google/apis/redis_v1beta1/representations.rb +139 -0
- data/generated/google/apis/redis_v1beta1.rb +1 -1
- data/generated/google/apis/remotebuildexecution_v1.rb +1 -1
- data/generated/google/apis/remotebuildexecution_v1alpha.rb +1 -1
- data/generated/google/apis/remotebuildexecution_v2.rb +1 -1
- data/generated/google/apis/reseller_v1/classes.rb +219 -160
- data/generated/google/apis/reseller_v1/service.rb +247 -252
- data/generated/google/apis/reseller_v1.rb +4 -3
- data/generated/google/apis/run_v1/classes.rb +835 -1243
- data/generated/google/apis/run_v1/service.rb +234 -248
- data/generated/google/apis/run_v1.rb +2 -2
- data/generated/google/apis/run_v1alpha1/classes.rb +934 -1331
- data/generated/google/apis/run_v1alpha1/service.rb +322 -378
- data/generated/google/apis/run_v1alpha1.rb +2 -2
- data/generated/google/apis/run_v1beta1/classes.rb +209 -276
- data/generated/google/apis/run_v1beta1/service.rb +17 -19
- data/generated/google/apis/run_v1beta1.rb +2 -2
- data/generated/google/apis/runtimeconfig_v1/classes.rb +36 -40
- data/generated/google/apis/runtimeconfig_v1/service.rb +19 -22
- data/generated/google/apis/runtimeconfig_v1.rb +1 -1
- data/generated/google/apis/sasportal_v1alpha1/classes.rb +122 -219
- data/generated/google/apis/sasportal_v1alpha1/representations.rb +0 -32
- data/generated/google/apis/sasportal_v1alpha1/service.rb +38 -526
- data/generated/google/apis/sasportal_v1alpha1.rb +1 -1
- data/generated/google/apis/searchconsole_v1/classes.rb +2 -2
- data/generated/google/apis/searchconsole_v1/service.rb +3 -2
- data/generated/google/apis/searchconsole_v1.rb +4 -3
- 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_v1.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_v1beta1.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_v1p1alpha1.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/securitycenter_v1p1beta1.rb +1 -1
- data/generated/google/apis/serviceconsumermanagement_v1/classes.rb +1150 -1784
- data/generated/google/apis/serviceconsumermanagement_v1/service.rb +114 -141
- data/generated/google/apis/serviceconsumermanagement_v1.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/serviceconsumermanagement_v1beta1.rb +1 -1
- data/generated/google/apis/servicecontrol_v1/classes.rb +6 -6
- data/generated/google/apis/servicecontrol_v1.rb +1 -1
- 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/servicecontrol_v2.rb +38 -0
- data/generated/google/apis/servicemanagement_v1/classes.rb +50 -2
- data/generated/google/apis/servicemanagement_v1/representations.rb +14 -0
- data/generated/google/apis/servicemanagement_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_v1.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/servicenetworking_v1beta.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_v1.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/serviceusage_v1beta1.rb +1 -1
- data/generated/google/apis/sheets_v4/classes.rb +28 -28
- data/generated/google/apis/sheets_v4.rb +1 -1
- data/generated/google/apis/spanner_v1/classes.rb +3 -2
- data/generated/google/apis/spanner_v1.rb +1 -1
- data/generated/google/apis/sql_v1beta4/classes.rb +207 -200
- data/generated/google/apis/sql_v1beta4/representations.rb +2 -1
- data/generated/google/apis/sql_v1beta4/service.rb +2 -2
- data/generated/google/apis/sql_v1beta4.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/storagetransfer_v1.rb +1 -1
- 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_v1.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/tagmanager_v2.rb +2 -3
- data/generated/google/apis/testing_v1/classes.rb +63 -0
- data/generated/google/apis/testing_v1/representations.rb +32 -0
- data/generated/google/apis/testing_v1.rb +1 -1
- data/generated/google/apis/toolresults_v1beta3/classes.rb +671 -928
- data/generated/google/apis/toolresults_v1beta3/representations.rb +1 -0
- data/generated/google/apis/toolresults_v1beta3/service.rb +522 -640
- data/generated/google/apis/toolresults_v1beta3.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_v1.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/tpu_v1alpha1.rb +1 -1
- data/generated/google/apis/translate_v3/service.rb +14 -1
- data/generated/google/apis/translate_v3.rb +1 -1
- data/generated/google/apis/translate_v3beta1/service.rb +14 -1
- data/generated/google/apis/translate_v3beta1.rb +1 -1
- data/generated/google/apis/vision_v1/classes.rb +1304 -1868
- data/generated/google/apis/vision_v1/service.rb +254 -340
- data/generated/google/apis/vision_v1.rb +1 -1
- data/generated/google/apis/vision_v1p1beta1/classes.rb +1246 -1788
- data/generated/google/apis/vision_v1p1beta1/service.rb +91 -121
- data/generated/google/apis/vision_v1p1beta1.rb +1 -1
- data/generated/google/apis/vision_v1p2beta1/classes.rb +1246 -1788
- data/generated/google/apis/vision_v1p2beta1/service.rb +91 -121
- data/generated/google/apis/vision_v1p2beta1.rb +1 -1
- data/generated/google/apis/webfonts_v1/service.rb +2 -2
- data/generated/google/apis/webfonts_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_v1.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_v1alpha.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/websecurityscanner_v1beta.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_analytics_v2.rb +1 -1
- data/generated/google/apis/youtube_partner_v1/classes.rb +637 -761
- data/generated/google/apis/youtube_partner_v1/service.rb +521 -661
- data/generated/google/apis/youtube_partner_v1.rb +1 -1
- data/generated/google/apis/youtube_v3/classes.rb +943 -1175
- data/generated/google/apis/youtube_v3/representations.rb +1 -0
- data/generated/google/apis/youtube_v3/service.rb +1008 -1316
- data/generated/google/apis/youtube_v3.rb +1 -1
- data/generated/google/apis/youtubereporting_v1/classes.rb +20 -29
- data/generated/google/apis/youtubereporting_v1/service.rb +40 -43
- data/generated/google/apis/youtubereporting_v1.rb +1 -1
- data/lib/google/apis/core/base_service.rb +7 -1
- data/lib/google/apis/version.rb +1 -1
- metadata +23 -11
- data/generated/google/apis/cloudfunctions_v1beta2/classes.rb +0 -848
- 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
- data/generated/google/apis/fitness_v1.rb +0 -85
|
@@ -26,53 +26,48 @@ module Google
|
|
|
26
26
|
class AdminQuotaPolicy
|
|
27
27
|
include Google::Apis::Core::Hashable
|
|
28
28
|
|
|
29
|
-
# The cloud resource container at which the quota policy is created. The
|
|
30
|
-
#
|
|
29
|
+
# The cloud resource container at which the quota policy is created. The format
|
|
30
|
+
# is `container_type`/`container_number`
|
|
31
31
|
# Corresponds to the JSON property `container`
|
|
32
32
|
# @return [String]
|
|
33
33
|
attr_accessor :container
|
|
34
34
|
|
|
35
|
-
# If this map is nonempty, then this policy applies only to specific values
|
|
36
|
-
#
|
|
37
|
-
#
|
|
38
|
-
#
|
|
39
|
-
#
|
|
40
|
-
#
|
|
41
|
-
#
|
|
42
|
-
#
|
|
43
|
-
# * Keys other than "region" or "zone" are not valid.
|
|
35
|
+
# If this map is nonempty, then this policy applies only to specific values for
|
|
36
|
+
# dimensions defined in the limit unit. For example, an policy on a limit with
|
|
37
|
+
# the unit 1/`project`/`region` could contain an entry with the key "region" and
|
|
38
|
+
# the value "us-east-1"; the policy is only applied to quota consumed in that
|
|
39
|
+
# region. This map has the following restrictions: * If "region" appears as a
|
|
40
|
+
# key, its value must be a valid Cloud region. * If "zone" appears as a key, its
|
|
41
|
+
# value must be a valid Cloud zone. * Keys other than "region" or "zone" are not
|
|
42
|
+
# valid.
|
|
44
43
|
# Corresponds to the JSON property `dimensions`
|
|
45
44
|
# @return [Hash<String,String>]
|
|
46
45
|
attr_accessor :dimensions
|
|
47
46
|
|
|
48
|
-
# The name of the metric to which this policy applies.
|
|
49
|
-
# An example name would be:
|
|
47
|
+
# The name of the metric to which this policy applies. An example name would be:
|
|
50
48
|
# `compute.googleapis.com/cpus`
|
|
51
49
|
# Corresponds to the JSON property `metric`
|
|
52
50
|
# @return [String]
|
|
53
51
|
attr_accessor :metric
|
|
54
52
|
|
|
55
|
-
# The resource name of the policy.
|
|
56
|
-
#
|
|
57
|
-
#
|
|
58
|
-
#
|
|
59
|
-
# compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/adminQuotaPolicies/
|
|
60
|
-
# 4a3f2c1d`
|
|
53
|
+
# The resource name of the policy. This name is generated by the server when the
|
|
54
|
+
# policy is created. Example names would be: `organizations/123/services/compute.
|
|
55
|
+
# googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%
|
|
56
|
+
# 2Fproject%2Fregion/adminQuotaPolicies/4a3f2c1d`
|
|
61
57
|
# Corresponds to the JSON property `name`
|
|
62
58
|
# @return [String]
|
|
63
59
|
attr_accessor :name
|
|
64
60
|
|
|
65
|
-
# The quota policy value.
|
|
66
|
-
#
|
|
61
|
+
# The quota policy value. Can be any nonnegative integer, or -1 (unlimited quota)
|
|
62
|
+
# .
|
|
67
63
|
# Corresponds to the JSON property `policyValue`
|
|
68
64
|
# @return [Fixnum]
|
|
69
65
|
attr_accessor :policy_value
|
|
70
66
|
|
|
71
|
-
# The limit unit of the limit to which this policy applies.
|
|
72
|
-
#
|
|
73
|
-
#
|
|
74
|
-
#
|
|
75
|
-
# the literal characters ``` and ``` occur in the string.
|
|
67
|
+
# The limit unit of the limit to which this policy applies. An example unit
|
|
68
|
+
# would be: `1/`project`/`region`` Note that ``project`` and ``region`` are not
|
|
69
|
+
# placeholders in this example; the literal characters ``` and ``` occur in the
|
|
70
|
+
# string.
|
|
76
71
|
# Corresponds to the JSON property `unit`
|
|
77
72
|
# @return [String]
|
|
78
73
|
attr_accessor :unit
|
|
@@ -92,14 +87,13 @@ module Google
|
|
|
92
87
|
end
|
|
93
88
|
end
|
|
94
89
|
|
|
95
|
-
# Api is a light-weight descriptor for an API Interface.
|
|
96
|
-
#
|
|
97
|
-
#
|
|
98
|
-
#
|
|
99
|
-
#
|
|
100
|
-
#
|
|
101
|
-
#
|
|
102
|
-
# detailed terminology.
|
|
90
|
+
# Api is a light-weight descriptor for an API Interface. Interfaces are also
|
|
91
|
+
# described as "protocol buffer services" in some contexts, such as by the "
|
|
92
|
+
# service" keyword in a .proto file, but they are different from API Services,
|
|
93
|
+
# which represent a concrete implementation of an interface as opposed to simply
|
|
94
|
+
# a description of methods and bindings. They are also sometimes simply referred
|
|
95
|
+
# to as "APIs" in other contexts, such as the name of this message itself. See
|
|
96
|
+
# https://cloud.google.com/apis/design/glossary for detailed terminology.
|
|
103
97
|
class Api
|
|
104
98
|
include Google::Apis::Core::Hashable
|
|
105
99
|
|
|
@@ -113,8 +107,8 @@ module Google
|
|
|
113
107
|
# @return [Array<Google::Apis::ServiceusageV1beta1::Mixin>]
|
|
114
108
|
attr_accessor :mixins
|
|
115
109
|
|
|
116
|
-
# The fully qualified name of this interface, including package name
|
|
117
|
-
#
|
|
110
|
+
# The fully qualified name of this interface, including package name followed by
|
|
111
|
+
# the interface's simple name.
|
|
118
112
|
# Corresponds to the JSON property `name`
|
|
119
113
|
# @return [String]
|
|
120
114
|
attr_accessor :name
|
|
@@ -124,8 +118,8 @@ module Google
|
|
|
124
118
|
# @return [Array<Google::Apis::ServiceusageV1beta1::Option>]
|
|
125
119
|
attr_accessor :options
|
|
126
120
|
|
|
127
|
-
# `SourceContext` represents information about the source of a
|
|
128
|
-
#
|
|
121
|
+
# `SourceContext` represents information about the source of a protobuf element,
|
|
122
|
+
# like the file in which it is defined.
|
|
129
123
|
# Corresponds to the JSON property `sourceContext`
|
|
130
124
|
# @return [Google::Apis::ServiceusageV1beta1::SourceContext]
|
|
131
125
|
attr_accessor :source_context
|
|
@@ -135,23 +129,19 @@ module Google
|
|
|
135
129
|
# @return [String]
|
|
136
130
|
attr_accessor :syntax
|
|
137
131
|
|
|
138
|
-
# A version string for this interface. If specified, must have the form
|
|
139
|
-
#
|
|
140
|
-
#
|
|
141
|
-
#
|
|
142
|
-
#
|
|
143
|
-
#
|
|
144
|
-
#
|
|
145
|
-
#
|
|
146
|
-
#
|
|
147
|
-
#
|
|
148
|
-
#
|
|
149
|
-
#
|
|
150
|
-
#
|
|
151
|
-
# interface, which must end in `v<major-version>`, as in
|
|
152
|
-
# `google.feature.v1`. For major versions 0 and 1, the suffix can
|
|
153
|
-
# be omitted. Zero major versions must only be used for
|
|
154
|
-
# experimental, non-GA interfaces.
|
|
132
|
+
# A version string for this interface. If specified, must have the form `major-
|
|
133
|
+
# version.minor-version`, as in `1.10`. If the minor version is omitted, it
|
|
134
|
+
# defaults to zero. If the entire version field is empty, the major version is
|
|
135
|
+
# derived from the package name, as outlined below. If the field is not empty,
|
|
136
|
+
# the version in the package name will be verified to be consistent with what is
|
|
137
|
+
# provided here. The versioning schema uses [semantic versioning](http://semver.
|
|
138
|
+
# org) where the major version number indicates a breaking change and the minor
|
|
139
|
+
# version an additive, non-breaking change. Both version numbers are signals to
|
|
140
|
+
# users what to expect from different versions, and should be carefully chosen
|
|
141
|
+
# based on the product plan. The major version is also reflected in the package
|
|
142
|
+
# name of the interface, which must end in `v`, as in `google.feature.v1`. For
|
|
143
|
+
# major versions 0 and 1, the suffix can be omitted. Zero major versions must
|
|
144
|
+
# only be used for experimental, non-GA interfaces.
|
|
155
145
|
# Corresponds to the JSON property `version`
|
|
156
146
|
# @return [String]
|
|
157
147
|
attr_accessor :version
|
|
@@ -172,85 +162,63 @@ module Google
|
|
|
172
162
|
end
|
|
173
163
|
end
|
|
174
164
|
|
|
175
|
-
# Configuration for an authentication provider, including support for
|
|
176
|
-
#
|
|
177
|
-
# (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).
|
|
165
|
+
# Configuration for an authentication provider, including support for [JSON Web
|
|
166
|
+
# Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).
|
|
178
167
|
class AuthProvider
|
|
179
168
|
include Google::Apis::Core::Hashable
|
|
180
169
|
|
|
181
|
-
# The list of JWT
|
|
182
|
-
#
|
|
183
|
-
#
|
|
184
|
-
#
|
|
185
|
-
# be accepted.
|
|
186
|
-
# -
|
|
187
|
-
# - "https://[service.name]/"
|
|
188
|
-
# will be accepted.
|
|
189
|
-
# For example, if no audiences are in the setting, LibraryService API will
|
|
190
|
-
# accept JWTs with the following audiences:
|
|
191
|
-
# -
|
|
170
|
+
# The list of JWT [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-
|
|
171
|
+
# web-token-32#section-4.1.3). that are allowed to access. A JWT containing any
|
|
172
|
+
# of these audiences will be accepted. When this setting is absent, JWTs with
|
|
173
|
+
# audiences: - "https://[service.name]/[google.protobuf.Api.name]" - "https://[
|
|
174
|
+
# service.name]/" will be accepted. For example, if no audiences are in the
|
|
175
|
+
# setting, LibraryService API will accept JWTs with the following audiences: -
|
|
192
176
|
# https://library-example.googleapis.com/google.example.library.v1.
|
|
193
|
-
# LibraryService
|
|
194
|
-
#
|
|
195
|
-
#
|
|
196
|
-
# audiences: bookstore_android.apps.googleusercontent.com,
|
|
197
|
-
# bookstore_web.apps.googleusercontent.com
|
|
177
|
+
# LibraryService - https://library-example.googleapis.com/ Example: audiences:
|
|
178
|
+
# bookstore_android.apps.googleusercontent.com, bookstore_web.apps.
|
|
179
|
+
# googleusercontent.com
|
|
198
180
|
# Corresponds to the JSON property `audiences`
|
|
199
181
|
# @return [String]
|
|
200
182
|
attr_accessor :audiences
|
|
201
183
|
|
|
202
|
-
# Redirect URL if JWT token is required but not present or is expired.
|
|
203
|
-
#
|
|
184
|
+
# Redirect URL if JWT token is required but not present or is expired. Implement
|
|
185
|
+
# authorizationUrl of securityDefinitions in OpenAPI spec.
|
|
204
186
|
# Corresponds to the JSON property `authorizationUrl`
|
|
205
187
|
# @return [String]
|
|
206
188
|
attr_accessor :authorization_url
|
|
207
189
|
|
|
208
|
-
# The unique identifier of the auth provider. It will be referred to by
|
|
209
|
-
#
|
|
210
|
-
# Example: "bookstore_auth".
|
|
190
|
+
# The unique identifier of the auth provider. It will be referred to by `
|
|
191
|
+
# AuthRequirement.provider_id`. Example: "bookstore_auth".
|
|
211
192
|
# Corresponds to the JSON property `id`
|
|
212
193
|
# @return [String]
|
|
213
194
|
attr_accessor :id
|
|
214
195
|
|
|
215
|
-
# Identifies the principal that issued the JWT. See
|
|
216
|
-
#
|
|
217
|
-
#
|
|
218
|
-
#
|
|
219
|
-
# Example: 1234567-compute@developer.gserviceaccount.com
|
|
196
|
+
# Identifies the principal that issued the JWT. See https://tools.ietf.org/html/
|
|
197
|
+
# draft-ietf-oauth-json-web-token-32#section-4.1.1 Usually a URL or an email
|
|
198
|
+
# address. Example: https://securetoken.google.com Example: 1234567-compute@
|
|
199
|
+
# developer.gserviceaccount.com
|
|
220
200
|
# Corresponds to the JSON property `issuer`
|
|
221
201
|
# @return [String]
|
|
222
202
|
attr_accessor :issuer
|
|
223
203
|
|
|
224
|
-
# URL of the provider's public key set to validate signature of the JWT. See
|
|
225
|
-
#
|
|
226
|
-
#
|
|
227
|
-
#
|
|
228
|
-
#
|
|
229
|
-
#
|
|
230
|
-
# [OpenID
|
|
231
|
-
# Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html of
|
|
232
|
-
# the issuer.
|
|
233
|
-
# - can be inferred from the email domain of the issuer (e.g. a Google
|
|
234
|
-
# service account).
|
|
235
|
-
# Example: https://www.googleapis.com/oauth2/v1/certs
|
|
204
|
+
# URL of the provider's public key set to validate signature of the JWT. See [
|
|
205
|
+
# OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#
|
|
206
|
+
# ProviderMetadata). Optional if the key set document: - can be retrieved from [
|
|
207
|
+
# OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html
|
|
208
|
+
# of the issuer. - can be inferred from the email domain of the issuer (e.g. a
|
|
209
|
+
# Google service account). Example: https://www.googleapis.com/oauth2/v1/certs
|
|
236
210
|
# Corresponds to the JSON property `jwksUri`
|
|
237
211
|
# @return [String]
|
|
238
212
|
attr_accessor :jwks_uri
|
|
239
213
|
|
|
240
|
-
# Defines the locations to extract the JWT.
|
|
241
|
-
#
|
|
242
|
-
# The
|
|
243
|
-
#
|
|
244
|
-
#
|
|
245
|
-
#
|
|
246
|
-
#
|
|
247
|
-
#
|
|
248
|
-
# Default locations can be specified as followings:
|
|
249
|
-
# jwt_locations:
|
|
250
|
-
# - header: Authorization
|
|
251
|
-
# value_prefix: "Bearer "
|
|
252
|
-
# - header: x-goog-iap-jwt-assertion
|
|
253
|
-
# - query: access_token
|
|
214
|
+
# Defines the locations to extract the JWT. JWT locations can be either from
|
|
215
|
+
# HTTP headers or URL query parameters. The rule is that the first match wins.
|
|
216
|
+
# The checking order is: checking all headers first, then URL query parameters.
|
|
217
|
+
# If not specified, default to use following 3 locations: 1) Authorization:
|
|
218
|
+
# Bearer 2) x-goog-iap-jwt-assertion 3) access_token query parameter Default
|
|
219
|
+
# locations can be specified as followings: jwt_locations: - header:
|
|
220
|
+
# Authorization value_prefix: "Bearer " - header: x-goog-iap-jwt-assertion -
|
|
221
|
+
# query: access_token
|
|
254
222
|
# Corresponds to the JSON property `jwtLocations`
|
|
255
223
|
# @return [Array<Google::Apis::ServiceusageV1beta1::JwtLocation>]
|
|
256
224
|
attr_accessor :jwt_locations
|
|
@@ -270,34 +238,26 @@ module Google
|
|
|
270
238
|
end
|
|
271
239
|
end
|
|
272
240
|
|
|
273
|
-
# User-defined authentication requirements, including support for
|
|
274
|
-
#
|
|
275
|
-
# (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).
|
|
241
|
+
# User-defined authentication requirements, including support for [JSON Web
|
|
242
|
+
# Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).
|
|
276
243
|
class AuthRequirement
|
|
277
244
|
include Google::Apis::Core::Hashable
|
|
278
245
|
|
|
279
|
-
# NOTE: This will be deprecated soon, once AuthProvider.audiences is
|
|
280
|
-
#
|
|
281
|
-
#
|
|
282
|
-
#
|
|
283
|
-
#
|
|
284
|
-
#
|
|
285
|
-
#
|
|
286
|
-
# "https://
|
|
287
|
-
#
|
|
288
|
-
#
|
|
289
|
-
# "https://library-example.googleapis.com/google.example.library.v1.
|
|
290
|
-
# LibraryService".
|
|
291
|
-
# Example:
|
|
292
|
-
# audiences: bookstore_android.apps.googleusercontent.com,
|
|
293
|
-
# bookstore_web.apps.googleusercontent.com
|
|
246
|
+
# NOTE: This will be deprecated soon, once AuthProvider.audiences is implemented
|
|
247
|
+
# and accepted in all the runtime components. The list of JWT [audiences](https:/
|
|
248
|
+
# /tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). that
|
|
249
|
+
# are allowed to access. A JWT containing any of these audiences will be
|
|
250
|
+
# accepted. When this setting is absent, only JWTs with audience "https://
|
|
251
|
+
# Service_name/API_name" will be accepted. For example, if no audiences are in
|
|
252
|
+
# the setting, LibraryService API will only accept JWTs with the following
|
|
253
|
+
# audience "https://library-example.googleapis.com/google.example.library.v1.
|
|
254
|
+
# LibraryService". Example: audiences: bookstore_android.apps.googleusercontent.
|
|
255
|
+
# com, bookstore_web.apps.googleusercontent.com
|
|
294
256
|
# Corresponds to the JSON property `audiences`
|
|
295
257
|
# @return [String]
|
|
296
258
|
attr_accessor :audiences
|
|
297
259
|
|
|
298
|
-
# id from authentication provider.
|
|
299
|
-
# Example:
|
|
300
|
-
# provider_id: bookstore_auth
|
|
260
|
+
# id from authentication provider. Example: provider_id: bookstore_auth
|
|
301
261
|
# Corresponds to the JSON property `providerId`
|
|
302
262
|
# @return [String]
|
|
303
263
|
attr_accessor :provider_id
|
|
@@ -313,18 +273,11 @@ module Google
|
|
|
313
273
|
end
|
|
314
274
|
end
|
|
315
275
|
|
|
316
|
-
# `Authentication` defines the authentication configuration for an API.
|
|
317
|
-
#
|
|
318
|
-
#
|
|
319
|
-
#
|
|
320
|
-
#
|
|
321
|
-
# - id: google_calendar_auth
|
|
322
|
-
# jwks_uri: https://www.googleapis.com/oauth2/v1/certs
|
|
323
|
-
# issuer: https://securetoken.google.com
|
|
324
|
-
# rules:
|
|
325
|
-
# - selector: "*"
|
|
326
|
-
# requirements:
|
|
327
|
-
# provider_id: google_calendar_auth
|
|
276
|
+
# `Authentication` defines the authentication configuration for an API. Example
|
|
277
|
+
# for an API targeted for external use: name: calendar.googleapis.com
|
|
278
|
+
# authentication: providers: - id: google_calendar_auth jwks_uri: https://www.
|
|
279
|
+
# googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: -
|
|
280
|
+
# selector: "*" requirements: provider_id: google_calendar_auth
|
|
328
281
|
class Authentication
|
|
329
282
|
include Google::Apis::Core::Hashable
|
|
330
283
|
|
|
@@ -333,8 +286,8 @@ module Google
|
|
|
333
286
|
# @return [Array<Google::Apis::ServiceusageV1beta1::AuthProvider>]
|
|
334
287
|
attr_accessor :providers
|
|
335
288
|
|
|
336
|
-
# A list of authentication rules that apply to individual API methods.
|
|
337
|
-
#
|
|
289
|
+
# A list of authentication rules that apply to individual API methods. **NOTE:**
|
|
290
|
+
# All service configuration rules follow "last one wins" order.
|
|
338
291
|
# Corresponds to the JSON property `rules`
|
|
339
292
|
# @return [Array<Google::Apis::ServiceusageV1beta1::AuthenticationRule>]
|
|
340
293
|
attr_accessor :rules
|
|
@@ -350,13 +303,11 @@ module Google
|
|
|
350
303
|
end
|
|
351
304
|
end
|
|
352
305
|
|
|
353
|
-
# Authentication rules for the service.
|
|
354
|
-
#
|
|
355
|
-
#
|
|
356
|
-
#
|
|
357
|
-
# request.
|
|
358
|
-
# If a method doesn't have any auth requirements, request credentials will be
|
|
359
|
-
# ignored.
|
|
306
|
+
# Authentication rules for the service. By default, if a method has any
|
|
307
|
+
# authentication requirements, every request must include a valid credential
|
|
308
|
+
# matching one of the requirements. It's an error to include more than one kind
|
|
309
|
+
# of credential in a single request. If a method doesn't have any auth
|
|
310
|
+
# requirements, request credentials will be ignored.
|
|
360
311
|
class AuthenticationRule
|
|
361
312
|
include Google::Apis::Core::Hashable
|
|
362
313
|
|
|
@@ -367,19 +318,18 @@ module Google
|
|
|
367
318
|
alias_method :allow_without_credential?, :allow_without_credential
|
|
368
319
|
|
|
369
320
|
# OAuth scopes are a way to define data and permissions on data. For example,
|
|
370
|
-
# there are scopes defined for "Read-only access to Google Calendar" and
|
|
371
|
-
#
|
|
372
|
-
#
|
|
373
|
-
#
|
|
374
|
-
#
|
|
375
|
-
#
|
|
376
|
-
#
|
|
377
|
-
#
|
|
378
|
-
#
|
|
379
|
-
#
|
|
380
|
-
#
|
|
381
|
-
#
|
|
382
|
-
# due to the backend requiring additional scopes or permissions.
|
|
321
|
+
# there are scopes defined for "Read-only access to Google Calendar" and "Access
|
|
322
|
+
# to Cloud Platform". Users can consent to a scope for an application, giving it
|
|
323
|
+
# permission to access that data on their behalf. OAuth scope specifications
|
|
324
|
+
# should be fairly coarse grained; a user will need to see and understand the
|
|
325
|
+
# text description of what your scope means. In most cases: use one or at most
|
|
326
|
+
# two OAuth scopes for an entire family of products. If your product has
|
|
327
|
+
# multiple APIs, you should probably be sharing the OAuth scope across all of
|
|
328
|
+
# those APIs. When you need finer grained OAuth consent screens: talk with your
|
|
329
|
+
# product management about how developers will use them in practice. Please note
|
|
330
|
+
# that even though each of the canonical scopes is enough for a request to be
|
|
331
|
+
# accepted and passed to the backend, a request can still fail due to the
|
|
332
|
+
# backend requiring additional scopes or permissions.
|
|
383
333
|
# Corresponds to the JSON property `oauth`
|
|
384
334
|
# @return [Google::Apis::ServiceusageV1beta1::OAuthRequirements]
|
|
385
335
|
attr_accessor :oauth
|
|
@@ -389,8 +339,8 @@ module Google
|
|
|
389
339
|
# @return [Array<Google::Apis::ServiceusageV1beta1::AuthRequirement>]
|
|
390
340
|
attr_accessor :requirements
|
|
391
341
|
|
|
392
|
-
# Selects the methods to which this rule applies.
|
|
393
|
-
#
|
|
342
|
+
# Selects the methods to which this rule applies. Refer to selector for syntax
|
|
343
|
+
# details.
|
|
394
344
|
# Corresponds to the JSON property `selector`
|
|
395
345
|
# @return [String]
|
|
396
346
|
attr_accessor :selector
|
|
@@ -412,8 +362,8 @@ module Google
|
|
|
412
362
|
class Backend
|
|
413
363
|
include Google::Apis::Core::Hashable
|
|
414
364
|
|
|
415
|
-
# A list of API backend rules that apply to individual API methods.
|
|
416
|
-
#
|
|
365
|
+
# A list of API backend rules that apply to individual API methods. **NOTE:**
|
|
366
|
+
# All service configuration rules follow "last one wins" order.
|
|
417
367
|
# Corresponds to the JSON property `rules`
|
|
418
368
|
# @return [Array<Google::Apis::ServiceusageV1beta1::BackendRule>]
|
|
419
369
|
attr_accessor :rules
|
|
@@ -432,21 +382,13 @@ module Google
|
|
|
432
382
|
class BackendRule
|
|
433
383
|
include Google::Apis::Core::Hashable
|
|
434
384
|
|
|
435
|
-
# The address of the API backend.
|
|
436
|
-
#
|
|
437
|
-
#
|
|
438
|
-
#
|
|
439
|
-
#
|
|
440
|
-
#
|
|
441
|
-
#
|
|
442
|
-
# grpcs:// gRPC TLS
|
|
443
|
-
# It is recommended to explicitly include a scheme. Leaving out the scheme
|
|
444
|
-
# may cause constrasting behaviors across platforms.
|
|
445
|
-
# If the port is unspecified, the default is:
|
|
446
|
-
# - 80 for schemes without TLS
|
|
447
|
-
# - 443 for schemes with TLS
|
|
448
|
-
# For HTTP backends, use protocol
|
|
449
|
-
# to specify the protocol version.
|
|
385
|
+
# The address of the API backend. The scheme is used to determine the backend
|
|
386
|
+
# protocol and security. The following schemes are accepted: SCHEME PROTOCOL
|
|
387
|
+
# SECURITY http:// HTTP None https:// HTTP TLS grpc:// gRPC None grpcs:// gRPC
|
|
388
|
+
# TLS It is recommended to explicitly include a scheme. Leaving out the scheme
|
|
389
|
+
# may cause constrasting behaviors across platforms. If the port is unspecified,
|
|
390
|
+
# the default is: - 80 for schemes without TLS - 443 for schemes with TLS For
|
|
391
|
+
# HTTP backends, use protocol to specify the protocol version.
|
|
450
392
|
# Corresponds to the JSON property `address`
|
|
451
393
|
# @return [String]
|
|
452
394
|
attr_accessor :address
|
|
@@ -457,18 +399,18 @@ module Google
|
|
|
457
399
|
# @return [Float]
|
|
458
400
|
attr_accessor :deadline
|
|
459
401
|
|
|
460
|
-
# When disable_auth is true, a JWT ID token won't be generated and the
|
|
461
|
-
#
|
|
462
|
-
#
|
|
463
|
-
#
|
|
402
|
+
# When disable_auth is true, a JWT ID token won't be generated and the original "
|
|
403
|
+
# Authorization" HTTP header will be preserved. If the header is used to carry
|
|
404
|
+
# the original token and is expected by the backend, this field must be set to
|
|
405
|
+
# true to preserve the header.
|
|
464
406
|
# Corresponds to the JSON property `disableAuth`
|
|
465
407
|
# @return [Boolean]
|
|
466
408
|
attr_accessor :disable_auth
|
|
467
409
|
alias_method :disable_auth?, :disable_auth
|
|
468
410
|
|
|
469
|
-
# The JWT audience is used when generating a JWT ID token for the backend.
|
|
470
|
-
#
|
|
471
|
-
#
|
|
411
|
+
# The JWT audience is used when generating a JWT ID token for the backend. This
|
|
412
|
+
# ID token will be added in the HTTP "authorization" header, and sent to the
|
|
413
|
+
# backend.
|
|
472
414
|
# Corresponds to the JSON property `jwtAudience`
|
|
473
415
|
# @return [String]
|
|
474
416
|
attr_accessor :jwt_audience
|
|
@@ -479,8 +421,8 @@ module Google
|
|
|
479
421
|
# @return [Float]
|
|
480
422
|
attr_accessor :min_deadline
|
|
481
423
|
|
|
482
|
-
# The number of seconds to wait for the completion of a long running
|
|
483
|
-
#
|
|
424
|
+
# The number of seconds to wait for the completion of a long running operation.
|
|
425
|
+
# The default is no deadline.
|
|
484
426
|
# Corresponds to the JSON property `operationDeadline`
|
|
485
427
|
# @return [Float]
|
|
486
428
|
attr_accessor :operation_deadline
|
|
@@ -490,29 +432,21 @@ module Google
|
|
|
490
432
|
# @return [String]
|
|
491
433
|
attr_accessor :path_translation
|
|
492
434
|
|
|
493
|
-
# The protocol used for sending a request to the backend.
|
|
494
|
-
#
|
|
495
|
-
#
|
|
496
|
-
#
|
|
497
|
-
#
|
|
498
|
-
#
|
|
499
|
-
# https://
|
|
500
|
-
#
|
|
501
|
-
#
|
|
502
|
-
# For secure HTTP backends (https://) that support HTTP/2, set this field
|
|
503
|
-
# to "h2" for improved performance.
|
|
504
|
-
# Configuring this field to non-default values is only supported for secure
|
|
505
|
-
# HTTP backends. This field will be ignored for all other backends.
|
|
506
|
-
# See
|
|
507
|
-
# https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-
|
|
508
|
-
# values.xhtml#alpn-protocol-ids
|
|
509
|
-
# for more details on the supported values.
|
|
435
|
+
# The protocol used for sending a request to the backend. The supported values
|
|
436
|
+
# are "http/1.1" and "h2". The default value is inferred from the scheme in the
|
|
437
|
+
# address field: SCHEME PROTOCOL http:// http/1.1 https:// http/1.1 grpc:// h2
|
|
438
|
+
# grpcs:// h2 For secure HTTP backends (https://) that support HTTP/2, set this
|
|
439
|
+
# field to "h2" for improved performance. Configuring this field to non-default
|
|
440
|
+
# values is only supported for secure HTTP backends. This field will be ignored
|
|
441
|
+
# for all other backends. See https://www.iana.org/assignments/tls-extensiontype-
|
|
442
|
+
# values/tls-extensiontype-values.xhtml#alpn-protocol-ids for more details on
|
|
443
|
+
# the supported values.
|
|
510
444
|
# Corresponds to the JSON property `protocol`
|
|
511
445
|
# @return [String]
|
|
512
446
|
attr_accessor :protocol
|
|
513
447
|
|
|
514
|
-
# Selects the methods to which this rule applies.
|
|
515
|
-
#
|
|
448
|
+
# Selects the methods to which this rule applies. Refer to selector for syntax
|
|
449
|
+
# details.
|
|
516
450
|
# Corresponds to the JSON property `selector`
|
|
517
451
|
# @return [String]
|
|
518
452
|
attr_accessor :selector
|
|
@@ -577,16 +511,13 @@ module Google
|
|
|
577
511
|
class BatchEnableServicesRequest
|
|
578
512
|
include Google::Apis::Core::Hashable
|
|
579
513
|
|
|
580
|
-
# The identifiers of the services to enable on the project.
|
|
581
|
-
#
|
|
582
|
-
#
|
|
583
|
-
#
|
|
584
|
-
#
|
|
585
|
-
#
|
|
586
|
-
#
|
|
587
|
-
# A single request can enable a maximum of 20 services at a time. If more
|
|
588
|
-
# than 20 services are specified, the request will fail, and no state changes
|
|
589
|
-
# will occur.
|
|
514
|
+
# The identifiers of the services to enable on the project. A valid identifier
|
|
515
|
+
# would be: serviceusage.googleapis.com Enabling services requires that each
|
|
516
|
+
# service is public or is shared with the user enabling the service. Two or more
|
|
517
|
+
# services must be specified. To enable a single service, use the `EnableService`
|
|
518
|
+
# method instead. A single request can enable a maximum of 20 services at a
|
|
519
|
+
# time. If more than 20 services are specified, the request will fail, and no
|
|
520
|
+
# state changes will occur.
|
|
590
521
|
# Corresponds to the JSON property `serviceIds`
|
|
591
522
|
# @return [Array<String>]
|
|
592
523
|
attr_accessor :service_ids
|
|
@@ -601,9 +532,9 @@ module Google
|
|
|
601
532
|
end
|
|
602
533
|
end
|
|
603
534
|
|
|
604
|
-
# Response message for the `BatchEnableServices` method.
|
|
605
|
-
#
|
|
606
|
-
#
|
|
535
|
+
# Response message for the `BatchEnableServices` method. This response message
|
|
536
|
+
# is assigned to the `response` field of the returned Operation when that
|
|
537
|
+
# operation is done.
|
|
607
538
|
class BatchEnableServicesResponse
|
|
608
539
|
include Google::Apis::Core::Hashable
|
|
609
540
|
|
|
@@ -629,42 +560,28 @@ module Google
|
|
|
629
560
|
end
|
|
630
561
|
end
|
|
631
562
|
|
|
632
|
-
# Billing related configuration of the service.
|
|
633
|
-
#
|
|
634
|
-
#
|
|
635
|
-
#
|
|
636
|
-
#
|
|
637
|
-
#
|
|
638
|
-
#
|
|
639
|
-
#
|
|
640
|
-
# -
|
|
641
|
-
#
|
|
642
|
-
# - key:
|
|
643
|
-
#
|
|
644
|
-
#
|
|
645
|
-
# -
|
|
646
|
-
#
|
|
647
|
-
# Custom label to define the city where the library branch is located
|
|
648
|
-
# in.
|
|
649
|
-
# - key: name
|
|
650
|
-
# description: Custom label to define the name of the library branch.
|
|
651
|
-
# metrics:
|
|
652
|
-
# - name: library.googleapis.com/book/borrowed_count
|
|
653
|
-
# metric_kind: DELTA
|
|
654
|
-
# value_type: INT64
|
|
655
|
-
# unit: "1"
|
|
656
|
-
# billing:
|
|
657
|
-
# consumer_destinations:
|
|
658
|
-
# - monitored_resource: library.googleapis.com/billing_branch
|
|
659
|
-
# metrics:
|
|
660
|
-
# - library.googleapis.com/book/borrowed_count
|
|
563
|
+
# Billing related configuration of the service. The following example shows how
|
|
564
|
+
# to configure monitored resources and metrics for billing, `
|
|
565
|
+
# consumer_destinations` is the only supported destination and the monitored
|
|
566
|
+
# resources need at least one label key `cloud.googleapis.com/location` to
|
|
567
|
+
# indicate the location of the billing usage, using different monitored
|
|
568
|
+
# resources between monitoring and billing is recommended so they can be evolved
|
|
569
|
+
# independently: monitored_resources: - type: library.googleapis.com/
|
|
570
|
+
# billing_branch labels: - key: cloud.googleapis.com/location description: |
|
|
571
|
+
# Predefined label to support billing location restriction. - key: city
|
|
572
|
+
# description: | Custom label to define the city where the library branch is
|
|
573
|
+
# located in. - key: name description: Custom label to define the name of the
|
|
574
|
+
# library branch. metrics: - name: library.googleapis.com/book/borrowed_count
|
|
575
|
+
# metric_kind: DELTA value_type: INT64 unit: "1" billing: consumer_destinations:
|
|
576
|
+
# - monitored_resource: library.googleapis.com/billing_branch metrics: - library.
|
|
577
|
+
# googleapis.com/book/borrowed_count
|
|
661
578
|
class Billing
|
|
662
579
|
include Google::Apis::Core::Hashable
|
|
663
580
|
|
|
664
|
-
# Billing configurations for sending metrics to the consumer project.
|
|
665
|
-
#
|
|
666
|
-
#
|
|
667
|
-
#
|
|
581
|
+
# Billing configurations for sending metrics to the consumer project. There can
|
|
582
|
+
# be multiple consumer destinations per service, each one must have a different
|
|
583
|
+
# monitored resource type. A metric can be used in at most one consumer
|
|
584
|
+
# destination.
|
|
668
585
|
# Corresponds to the JSON property `consumerDestinations`
|
|
669
586
|
# @return [Array<Google::Apis::ServiceusageV1beta1::BillingDestination>]
|
|
670
587
|
attr_accessor :consumer_destinations
|
|
@@ -679,19 +596,19 @@ module Google
|
|
|
679
596
|
end
|
|
680
597
|
end
|
|
681
598
|
|
|
682
|
-
# Configuration of a specific billing destination (Currently only support
|
|
683
|
-
#
|
|
599
|
+
# Configuration of a specific billing destination (Currently only support bill
|
|
600
|
+
# against consumer project).
|
|
684
601
|
class BillingDestination
|
|
685
602
|
include Google::Apis::Core::Hashable
|
|
686
603
|
|
|
687
|
-
# Names of the metrics to report to this billing destination.
|
|
688
|
-
#
|
|
604
|
+
# Names of the metrics to report to this billing destination. Each name must be
|
|
605
|
+
# defined in Service.metrics section.
|
|
689
606
|
# Corresponds to the JSON property `metrics`
|
|
690
607
|
# @return [Array<String>]
|
|
691
608
|
attr_accessor :metrics
|
|
692
609
|
|
|
693
|
-
# The monitored resource type. The type must be defined in
|
|
694
|
-
#
|
|
610
|
+
# The monitored resource type. The type must be defined in Service.
|
|
611
|
+
# monitored_resources section.
|
|
695
612
|
# Corresponds to the JSON property `monitoredResource`
|
|
696
613
|
# @return [String]
|
|
697
614
|
attr_accessor :monitored_resource
|
|
@@ -723,35 +640,31 @@ module Google
|
|
|
723
640
|
attr_accessor :is_precise
|
|
724
641
|
alias_method :is_precise?, :is_precise
|
|
725
642
|
|
|
726
|
-
# The name of the parent metric of this limit.
|
|
727
|
-
#
|
|
728
|
-
# `compute.googleapis.com/cpus`
|
|
643
|
+
# The name of the parent metric of this limit. An example name would be: `
|
|
644
|
+
# compute.googleapis.com/cpus`
|
|
729
645
|
# Corresponds to the JSON property `metric`
|
|
730
646
|
# @return [String]
|
|
731
647
|
attr_accessor :metric
|
|
732
648
|
|
|
733
|
-
# The resource name of the quota limit.
|
|
734
|
-
#
|
|
735
|
-
# `
|
|
736
|
-
#
|
|
737
|
-
#
|
|
738
|
-
# its component strings, since its representation could change in the future.
|
|
649
|
+
# The resource name of the quota limit. An example name would be: `projects/123/
|
|
650
|
+
# services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%
|
|
651
|
+
# 2Fcpus/limits/%2Fproject%2Fregion` The resource name is intended to be opaque
|
|
652
|
+
# and should not be parsed for its component strings, since its representation
|
|
653
|
+
# could change in the future.
|
|
739
654
|
# Corresponds to the JSON property `name`
|
|
740
655
|
# @return [String]
|
|
741
656
|
attr_accessor :name
|
|
742
657
|
|
|
743
|
-
# Summary of the enforced quota buckets, organized by quota dimension,
|
|
744
|
-
#
|
|
745
|
-
#
|
|
658
|
+
# Summary of the enforced quota buckets, organized by quota dimension, ordered
|
|
659
|
+
# from least specific to most specific (for example, the global default bucket,
|
|
660
|
+
# with no quota dimensions, will always appear first).
|
|
746
661
|
# Corresponds to the JSON property `quotaBuckets`
|
|
747
662
|
# @return [Array<Google::Apis::ServiceusageV1beta1::QuotaBucket>]
|
|
748
663
|
attr_accessor :quota_buckets
|
|
749
664
|
|
|
750
|
-
# The limit unit.
|
|
751
|
-
#
|
|
752
|
-
#
|
|
753
|
-
# Note that ``project`` and ``region`` are not placeholders in this example;
|
|
754
|
-
# the literal characters ``` and ``` occur in the string.
|
|
665
|
+
# The limit unit. An example unit would be `1/`project`/`region`` Note that ``
|
|
666
|
+
# project`` and ``region`` are not placeholders in this example; the literal
|
|
667
|
+
# characters ``` and ``` occur in the string.
|
|
755
668
|
# Corresponds to the JSON property `unit`
|
|
756
669
|
# @return [String]
|
|
757
670
|
attr_accessor :unit
|
|
@@ -780,26 +693,21 @@ module Google
|
|
|
780
693
|
# @return [Array<Google::Apis::ServiceusageV1beta1::ConsumerQuotaLimit>]
|
|
781
694
|
attr_accessor :consumer_quota_limits
|
|
782
695
|
|
|
783
|
-
# The display name of the metric.
|
|
784
|
-
# An example name would be:
|
|
785
|
-
# "CPUs"
|
|
696
|
+
# The display name of the metric. An example name would be: "CPUs"
|
|
786
697
|
# Corresponds to the JSON property `displayName`
|
|
787
698
|
# @return [String]
|
|
788
699
|
attr_accessor :display_name
|
|
789
700
|
|
|
790
|
-
# The name of the metric.
|
|
791
|
-
# An example name would be:
|
|
792
|
-
# `compute.googleapis.com/cpus`
|
|
701
|
+
# The name of the metric. An example name would be: `compute.googleapis.com/cpus`
|
|
793
702
|
# Corresponds to the JSON property `metric`
|
|
794
703
|
# @return [String]
|
|
795
704
|
attr_accessor :metric
|
|
796
705
|
|
|
797
|
-
# The resource name of the quota settings on this metric for this consumer.
|
|
798
|
-
#
|
|
799
|
-
#
|
|
800
|
-
#
|
|
801
|
-
#
|
|
802
|
-
# its component strings, since its representation could change in the future.
|
|
706
|
+
# The resource name of the quota settings on this metric for this consumer. An
|
|
707
|
+
# example name would be: `projects/123/services/compute.googleapis.com/
|
|
708
|
+
# consumerQuotaMetrics/compute.googleapis.com%2Fcpus The resource name is
|
|
709
|
+
# intended to be opaque and should not be parsed for its component strings,
|
|
710
|
+
# since its representation could change in the future.
|
|
803
711
|
# Corresponds to the JSON property `name`
|
|
804
712
|
# @return [String]
|
|
805
713
|
attr_accessor :name
|
|
@@ -823,39 +731,24 @@ module Google
|
|
|
823
731
|
end
|
|
824
732
|
end
|
|
825
733
|
|
|
826
|
-
# `Context` defines which contexts an API requests.
|
|
827
|
-
#
|
|
828
|
-
# context
|
|
829
|
-
#
|
|
830
|
-
#
|
|
831
|
-
#
|
|
832
|
-
# -
|
|
833
|
-
#
|
|
834
|
-
#
|
|
835
|
-
#
|
|
836
|
-
#
|
|
837
|
-
#
|
|
838
|
-
#
|
|
839
|
-
# This also provides mechanism to whitelist any protobuf message extension that
|
|
840
|
-
# can be sent in grpc metadata using “x-goog-ext-<extension_id>-bin” and
|
|
841
|
-
# “x-goog-ext-<extension_id>-jspb” format. For example, list any service
|
|
842
|
-
# specific protobuf types that can appear in grpc metadata as follows in your
|
|
843
|
-
# yaml file:
|
|
844
|
-
# Example:
|
|
845
|
-
# context:
|
|
846
|
-
# rules:
|
|
847
|
-
# - selector: "google.example.library.v1.LibraryService.CreateBook"
|
|
848
|
-
# allowed_request_extensions:
|
|
849
|
-
# - google.foo.v1.NewExtension
|
|
850
|
-
# allowed_response_extensions:
|
|
851
|
-
# - google.foo.v1.NewExtension
|
|
852
|
-
# You can also specify extension ID instead of fully qualified extension name
|
|
853
|
-
# here.
|
|
734
|
+
# `Context` defines which contexts an API requests. Example: context: rules: -
|
|
735
|
+
# selector: "*" requested: - google.rpc.context.ProjectContext - google.rpc.
|
|
736
|
+
# context.OriginContext The above specifies that all methods in the API request `
|
|
737
|
+
# google.rpc.context.ProjectContext` and `google.rpc.context.OriginContext`.
|
|
738
|
+
# Available context types are defined in package `google.rpc.context`. This also
|
|
739
|
+
# provides mechanism to whitelist any protobuf message extension that can be
|
|
740
|
+
# sent in grpc metadata using “x-goog-ext--bin” and “x-goog-ext--jspb” format.
|
|
741
|
+
# For example, list any service specific protobuf types that can appear in grpc
|
|
742
|
+
# metadata as follows in your yaml file: Example: context: rules: - selector: "
|
|
743
|
+
# google.example.library.v1.LibraryService.CreateBook"
|
|
744
|
+
# allowed_request_extensions: - google.foo.v1.NewExtension
|
|
745
|
+
# allowed_response_extensions: - google.foo.v1.NewExtension You can also specify
|
|
746
|
+
# extension ID instead of fully qualified extension name here.
|
|
854
747
|
class Context
|
|
855
748
|
include Google::Apis::Core::Hashable
|
|
856
749
|
|
|
857
|
-
# A list of RPC context rules that apply to individual API methods.
|
|
858
|
-
#
|
|
750
|
+
# A list of RPC context rules that apply to individual API methods. **NOTE:**
|
|
751
|
+
# All service configuration rules follow "last one wins" order.
|
|
859
752
|
# Corresponds to the JSON property `rules`
|
|
860
753
|
# @return [Array<Google::Apis::ServiceusageV1beta1::ContextRule>]
|
|
861
754
|
attr_accessor :rules
|
|
@@ -875,14 +768,14 @@ module Google
|
|
|
875
768
|
class ContextRule
|
|
876
769
|
include Google::Apis::Core::Hashable
|
|
877
770
|
|
|
878
|
-
# A list of full type names or extension IDs of extensions allowed in grpc
|
|
879
|
-
#
|
|
771
|
+
# A list of full type names or extension IDs of extensions allowed in grpc side
|
|
772
|
+
# channel from client to backend.
|
|
880
773
|
# Corresponds to the JSON property `allowedRequestExtensions`
|
|
881
774
|
# @return [Array<String>]
|
|
882
775
|
attr_accessor :allowed_request_extensions
|
|
883
776
|
|
|
884
|
-
# A list of full type names or extension IDs of extensions allowed in grpc
|
|
885
|
-
#
|
|
777
|
+
# A list of full type names or extension IDs of extensions allowed in grpc side
|
|
778
|
+
# channel from backend to client.
|
|
886
779
|
# Corresponds to the JSON property `allowedResponseExtensions`
|
|
887
780
|
# @return [Array<String>]
|
|
888
781
|
attr_accessor :allowed_response_extensions
|
|
@@ -897,8 +790,8 @@ module Google
|
|
|
897
790
|
# @return [Array<String>]
|
|
898
791
|
attr_accessor :requested
|
|
899
792
|
|
|
900
|
-
# Selects the methods to which this rule applies.
|
|
901
|
-
#
|
|
793
|
+
# Selects the methods to which this rule applies. Refer to selector for syntax
|
|
794
|
+
# details.
|
|
902
795
|
# Corresponds to the JSON property `selector`
|
|
903
796
|
# @return [String]
|
|
904
797
|
attr_accessor :selector
|
|
@@ -917,14 +810,14 @@ module Google
|
|
|
917
810
|
end
|
|
918
811
|
end
|
|
919
812
|
|
|
920
|
-
# Selects and configures the service controller used by the service.
|
|
921
|
-
#
|
|
922
|
-
#
|
|
813
|
+
# Selects and configures the service controller used by the service. The service
|
|
814
|
+
# controller handles features like abuse, quota, billing, logging, monitoring,
|
|
815
|
+
# etc.
|
|
923
816
|
class Control
|
|
924
817
|
include Google::Apis::Core::Hashable
|
|
925
818
|
|
|
926
|
-
# The service control environment to use. If empty, no control plane
|
|
927
|
-
#
|
|
819
|
+
# The service control environment to use. If empty, no control plane feature (
|
|
820
|
+
# like quota and billing) will be enabled.
|
|
928
821
|
# Corresponds to the JSON property `environment`
|
|
929
822
|
# @return [String]
|
|
930
823
|
attr_accessor :environment
|
|
@@ -939,19 +832,15 @@ module Google
|
|
|
939
832
|
end
|
|
940
833
|
end
|
|
941
834
|
|
|
942
|
-
# Customize service error responses.
|
|
943
|
-
#
|
|
944
|
-
#
|
|
945
|
-
#
|
|
946
|
-
# custom_error:
|
|
947
|
-
# types:
|
|
948
|
-
# - google.foo.v1.CustomError
|
|
949
|
-
# - google.foo.v1.AnotherError
|
|
835
|
+
# Customize service error responses. For example, list any service specific
|
|
836
|
+
# protobuf types that can appear in error detail lists of error responses.
|
|
837
|
+
# Example: custom_error: types: - google.foo.v1.CustomError - google.foo.v1.
|
|
838
|
+
# AnotherError
|
|
950
839
|
class CustomError
|
|
951
840
|
include Google::Apis::Core::Hashable
|
|
952
841
|
|
|
953
|
-
# The list of custom error rules that apply to individual API messages.
|
|
954
|
-
#
|
|
842
|
+
# The list of custom error rules that apply to individual API messages. **NOTE:**
|
|
843
|
+
# All service configuration rules follow "last one wins" order.
|
|
955
844
|
# Corresponds to the JSON property `rules`
|
|
956
845
|
# @return [Array<Google::Apis::ServiceusageV1beta1::CustomErrorRule>]
|
|
957
846
|
attr_accessor :rules
|
|
@@ -976,15 +865,15 @@ module Google
|
|
|
976
865
|
class CustomErrorRule
|
|
977
866
|
include Google::Apis::Core::Hashable
|
|
978
867
|
|
|
979
|
-
# Mark this message as possible payload in error response.
|
|
980
|
-
#
|
|
868
|
+
# Mark this message as possible payload in error response. Otherwise, objects of
|
|
869
|
+
# this type will be filtered when they appear in error payload.
|
|
981
870
|
# Corresponds to the JSON property `isErrorType`
|
|
982
871
|
# @return [Boolean]
|
|
983
872
|
attr_accessor :is_error_type
|
|
984
873
|
alias_method :is_error_type?, :is_error_type
|
|
985
874
|
|
|
986
|
-
# Selects messages to which this rule applies.
|
|
987
|
-
#
|
|
875
|
+
# Selects messages to which this rule applies. Refer to selector for syntax
|
|
876
|
+
# details.
|
|
988
877
|
# Corresponds to the JSON property `selector`
|
|
989
878
|
# @return [String]
|
|
990
879
|
attr_accessor :selector
|
|
@@ -1038,9 +927,9 @@ module Google
|
|
|
1038
927
|
end
|
|
1039
928
|
end
|
|
1040
929
|
|
|
1041
|
-
# Response message for the `DisableService` method.
|
|
1042
|
-
#
|
|
1043
|
-
#
|
|
930
|
+
# Response message for the `DisableService` method. This response message is
|
|
931
|
+
# assigned to the `response` field of the returned Operation when that operation
|
|
932
|
+
# is done.
|
|
1044
933
|
class DisableServiceResponse
|
|
1045
934
|
include Google::Apis::Core::Hashable
|
|
1046
935
|
|
|
@@ -1059,56 +948,32 @@ module Google
|
|
|
1059
948
|
end
|
|
1060
949
|
end
|
|
1061
950
|
|
|
1062
|
-
# `Documentation` provides the information for describing a service.
|
|
1063
|
-
#
|
|
1064
|
-
#
|
|
1065
|
-
#
|
|
1066
|
-
#
|
|
1067
|
-
#
|
|
1068
|
-
#
|
|
1069
|
-
#
|
|
1070
|
-
#
|
|
1071
|
-
#
|
|
1072
|
-
#
|
|
1073
|
-
#
|
|
1074
|
-
#
|
|
1075
|
-
#
|
|
1076
|
-
#
|
|
1077
|
-
#
|
|
1078
|
-
#
|
|
1079
|
-
#
|
|
1080
|
-
#
|
|
1081
|
-
#
|
|
1082
|
-
#
|
|
1083
|
-
#
|
|
1084
|
-
#
|
|
1085
|
-
#
|
|
1086
|
-
#
|
|
1087
|
-
#
|
|
1088
|
-
# a documentation fragment is embedded.
|
|
1089
|
-
# Documentation from the IDL is merged with documentation defined
|
|
1090
|
-
# via the config at normalization time, where documentation provided
|
|
1091
|
-
# by config rules overrides IDL provided.
|
|
1092
|
-
# A number of constructs specific to the API platform are supported
|
|
1093
|
-
# in documentation text.
|
|
1094
|
-
# In order to reference a proto element, the following
|
|
1095
|
-
# notation can be used:
|
|
1096
|
-
# <pre><code>[fully.qualified.proto.name][]</code></pre>
|
|
1097
|
-
# To override the display text used for the link, this can be used:
|
|
1098
|
-
# <pre><code>[display text][fully.qualified.proto.name]</code></pre>
|
|
1099
|
-
# Text can be excluded from doc using the following notation:
|
|
1100
|
-
# <pre><code>(-- internal comment --)</code></pre>
|
|
1101
|
-
# A few directives are available in documentation. Note that
|
|
1102
|
-
# directives must appear on a single line to be properly
|
|
1103
|
-
# identified. The `include` directive includes a markdown file from
|
|
1104
|
-
# an external source:
|
|
1105
|
-
# <pre><code>(== include path/to/file ==)</code></pre>
|
|
1106
|
-
# The `resource_for` directive marks a message to be the resource of
|
|
1107
|
-
# a collection in REST view. If it is not specified, tools attempt
|
|
1108
|
-
# to infer the resource from the operations in a collection:
|
|
1109
|
-
# <pre><code>(== resource_for v1.shelves.books ==)</code></pre>
|
|
1110
|
-
# The directive `suppress_warning` does not directly affect documentation
|
|
1111
|
-
# and is documented together with service config validation.
|
|
951
|
+
# `Documentation` provides the information for describing a service. Example:
|
|
952
|
+
# documentation: summary: > The Google Calendar API gives access to most
|
|
953
|
+
# calendar features. pages: - name: Overview content: (== include google/foo/
|
|
954
|
+
# overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==
|
|
955
|
+
# ) subpages; - name: Java content: (== include google/foo/tutorial_java.md ==)
|
|
956
|
+
# rules: - selector: google.calendar.Calendar.Get description: > ... - selector:
|
|
957
|
+
# google.calendar.Calendar.Put description: > ... Documentation is provided in
|
|
958
|
+
# markdown syntax. In addition to standard markdown features, definition lists,
|
|
959
|
+
# tables and fenced code blocks are supported. Section headers can be provided
|
|
960
|
+
# and are interpreted relative to the section nesting of the context where a
|
|
961
|
+
# documentation fragment is embedded. Documentation from the IDL is merged with
|
|
962
|
+
# documentation defined via the config at normalization time, where
|
|
963
|
+
# documentation provided by config rules overrides IDL provided. A number of
|
|
964
|
+
# constructs specific to the API platform are supported in documentation text.
|
|
965
|
+
# In order to reference a proto element, the following notation can be used: [
|
|
966
|
+
# fully.qualified.proto.name][] To override the display text used for the link,
|
|
967
|
+
# this can be used: [display text][fully.qualified.proto.name] Text can be
|
|
968
|
+
# excluded from doc using the following notation: (-- internal comment --) A few
|
|
969
|
+
# directives are available in documentation. Note that directives must appear on
|
|
970
|
+
# a single line to be properly identified. The `include` directive includes a
|
|
971
|
+
# markdown file from an external source: (== include path/to/file ==) The `
|
|
972
|
+
# resource_for` directive marks a message to be the resource of a collection in
|
|
973
|
+
# REST view. If it is not specified, tools attempt to infer the resource from
|
|
974
|
+
# the operations in a collection: (== resource_for v1.shelves.books ==) The
|
|
975
|
+
# directive `suppress_warning` does not directly affect documentation and is
|
|
976
|
+
# documented together with service config validation.
|
|
1112
977
|
class Documentation
|
|
1113
978
|
include Google::Apis::Core::Hashable
|
|
1114
979
|
|
|
@@ -1117,19 +982,11 @@ module Google
|
|
|
1117
982
|
# @return [String]
|
|
1118
983
|
attr_accessor :documentation_root_url
|
|
1119
984
|
|
|
1120
|
-
# Declares a single overview page. For example:
|
|
1121
|
-
#
|
|
1122
|
-
# summary: ...
|
|
1123
|
-
#
|
|
1124
|
-
#
|
|
1125
|
-
# This is a shortcut for the following declaration (using pages style):
|
|
1126
|
-
# <pre><code>documentation:
|
|
1127
|
-
# summary: ...
|
|
1128
|
-
# pages:
|
|
1129
|
-
# - name: Overview
|
|
1130
|
-
# content: (== include overview.md ==)
|
|
1131
|
-
# </code></pre>
|
|
1132
|
-
# Note: you cannot specify both `overview` field and `pages` field.
|
|
985
|
+
# Declares a single overview page. For example: documentation: summary: ...
|
|
986
|
+
# overview: (== include overview.md ==) This is a shortcut for the following
|
|
987
|
+
# declaration (using pages style): documentation: summary: ... pages: - name:
|
|
988
|
+
# Overview content: (== include overview.md ==) Note: you cannot specify both `
|
|
989
|
+
# overview` field and `pages` field.
|
|
1133
990
|
# Corresponds to the JSON property `overview`
|
|
1134
991
|
# @return [String]
|
|
1135
992
|
attr_accessor :overview
|
|
@@ -1139,22 +996,20 @@ module Google
|
|
|
1139
996
|
# @return [Array<Google::Apis::ServiceusageV1beta1::Page>]
|
|
1140
997
|
attr_accessor :pages
|
|
1141
998
|
|
|
1142
|
-
# A list of documentation rules that apply to individual API elements.
|
|
1143
|
-
#
|
|
999
|
+
# A list of documentation rules that apply to individual API elements. **NOTE:**
|
|
1000
|
+
# All service configuration rules follow "last one wins" order.
|
|
1144
1001
|
# Corresponds to the JSON property `rules`
|
|
1145
1002
|
# @return [Array<Google::Apis::ServiceusageV1beta1::DocumentationRule>]
|
|
1146
1003
|
attr_accessor :rules
|
|
1147
1004
|
|
|
1148
|
-
# Specifies the service root url if the default one (the service name
|
|
1149
|
-
#
|
|
1150
|
-
#
|
|
1151
|
-
# urls are relative to.
|
|
1005
|
+
# Specifies the service root url if the default one (the service name from the
|
|
1006
|
+
# yaml file) is not suitable. This can be seen in any fully specified service
|
|
1007
|
+
# urls as well as sections that show a base that other urls are relative to.
|
|
1152
1008
|
# Corresponds to the JSON property `serviceRootUrl`
|
|
1153
1009
|
# @return [String]
|
|
1154
1010
|
attr_accessor :service_root_url
|
|
1155
1011
|
|
|
1156
|
-
# A short summary of what the service does. Can only be provided by
|
|
1157
|
-
# plain text.
|
|
1012
|
+
# A short summary of what the service does. Can only be provided by plain text.
|
|
1158
1013
|
# Corresponds to the JSON property `summary`
|
|
1159
1014
|
# @return [String]
|
|
1160
1015
|
attr_accessor :summary
|
|
@@ -1178,8 +1033,8 @@ module Google
|
|
|
1178
1033
|
class DocumentationRule
|
|
1179
1034
|
include Google::Apis::Core::Hashable
|
|
1180
1035
|
|
|
1181
|
-
# Deprecation description of the selected element(s). It can be provided if
|
|
1182
|
-
#
|
|
1036
|
+
# Deprecation description of the selected element(s). It can be provided if an
|
|
1037
|
+
# element is marked as `deprecated`.
|
|
1183
1038
|
# Corresponds to the JSON property `deprecationDescription`
|
|
1184
1039
|
# @return [String]
|
|
1185
1040
|
attr_accessor :deprecation_description
|
|
@@ -1211,13 +1066,11 @@ module Google
|
|
|
1211
1066
|
end
|
|
1212
1067
|
end
|
|
1213
1068
|
|
|
1214
|
-
# A generic empty message that you can re-use to avoid defining duplicated
|
|
1215
|
-
#
|
|
1216
|
-
#
|
|
1217
|
-
#
|
|
1218
|
-
#
|
|
1219
|
-
# `
|
|
1220
|
-
# The JSON representation for `Empty` is empty JSON object ````.
|
|
1069
|
+
# A generic empty message that you can re-use to avoid defining duplicated empty
|
|
1070
|
+
# messages in your APIs. A typical example is to use it as the request or the
|
|
1071
|
+
# response type of an API method. For instance: service Foo ` rpc Bar(google.
|
|
1072
|
+
# protobuf.Empty) returns (google.protobuf.Empty); ` The JSON representation for
|
|
1073
|
+
# `Empty` is empty JSON object ````.
|
|
1221
1074
|
class Empty
|
|
1222
1075
|
include Google::Apis::Core::Hashable
|
|
1223
1076
|
|
|
@@ -1268,9 +1121,9 @@ module Google
|
|
|
1268
1121
|
end
|
|
1269
1122
|
end
|
|
1270
1123
|
|
|
1271
|
-
# Response message for the `EnableService` method.
|
|
1272
|
-
#
|
|
1273
|
-
#
|
|
1124
|
+
# Response message for the `EnableService` method. This response message is
|
|
1125
|
+
# assigned to the `response` field of the returned Operation when that operation
|
|
1126
|
+
# is done.
|
|
1274
1127
|
class EnableServiceResponse
|
|
1275
1128
|
include Google::Apis::Core::Hashable
|
|
1276
1129
|
|
|
@@ -1289,35 +1142,28 @@ module Google
|
|
|
1289
1142
|
end
|
|
1290
1143
|
end
|
|
1291
1144
|
|
|
1292
|
-
# `Endpoint` describes a network endpoint that serves a set of APIs.
|
|
1293
|
-
#
|
|
1294
|
-
#
|
|
1295
|
-
# configuration.
|
|
1296
|
-
#
|
|
1297
|
-
#
|
|
1298
|
-
#
|
|
1299
|
-
# #
|
|
1300
|
-
#
|
|
1301
|
-
# # It also allows HTTP OPTIONS calls to be passed to the backend, for
|
|
1302
|
-
# # it to decide whether the subsequent cross-origin request is
|
|
1303
|
-
# # allowed to proceed.
|
|
1304
|
-
# - name: library-example.googleapis.com
|
|
1305
|
-
# allow_cors: true
|
|
1145
|
+
# `Endpoint` describes a network endpoint that serves a set of APIs. A service
|
|
1146
|
+
# may expose any number of endpoints, and all endpoints share the same service
|
|
1147
|
+
# configuration, such as quota configuration and monitoring configuration.
|
|
1148
|
+
# Example service configuration: name: library-example.googleapis.com endpoints:
|
|
1149
|
+
# # Below entry makes 'google.example.library.v1.Library' # API be served from
|
|
1150
|
+
# endpoint address library-example.googleapis.com. # It also allows HTTP OPTIONS
|
|
1151
|
+
# calls to be passed to the backend, for # it to decide whether the subsequent
|
|
1152
|
+
# cross-origin request is # allowed to proceed. - name: library-example.
|
|
1153
|
+
# googleapis.com allow_cors: true
|
|
1306
1154
|
class Endpoint
|
|
1307
1155
|
include Google::Apis::Core::Hashable
|
|
1308
1156
|
|
|
1309
1157
|
# DEPRECATED: This field is no longer supported. Instead of using aliases,
|
|
1310
|
-
# please specify multiple google.api.Endpoint for each of the intended
|
|
1311
|
-
# aliases.
|
|
1158
|
+
# please specify multiple google.api.Endpoint for each of the intended aliases.
|
|
1312
1159
|
# Additional names that this endpoint will be hosted on.
|
|
1313
1160
|
# Corresponds to the JSON property `aliases`
|
|
1314
1161
|
# @return [Array<String>]
|
|
1315
1162
|
attr_accessor :aliases
|
|
1316
1163
|
|
|
1317
|
-
# Allowing
|
|
1318
|
-
#
|
|
1319
|
-
#
|
|
1320
|
-
# receive and respond to HTTP OPTIONS requests. The response will be used by
|
|
1164
|
+
# Allowing [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing),
|
|
1165
|
+
# aka cross-domain traffic, would allow the backends served from this endpoint
|
|
1166
|
+
# to receive and respond to HTTP OPTIONS requests. The response will be used by
|
|
1321
1167
|
# the browser to determine whether the subsequent cross-origin request is
|
|
1322
1168
|
# allowed to proceed.
|
|
1323
1169
|
# Corresponds to the JSON property `allowCors`
|
|
@@ -1331,10 +1177,9 @@ module Google
|
|
|
1331
1177
|
attr_accessor :name
|
|
1332
1178
|
|
|
1333
1179
|
# The specification of an Internet routable address of API frontend that will
|
|
1334
|
-
# handle requests to this [API
|
|
1335
|
-
#
|
|
1336
|
-
#
|
|
1337
|
-
# "8.8.8.8" or "myservice.appspot.com".
|
|
1180
|
+
# handle requests to this [API Endpoint](https://cloud.google.com/apis/design/
|
|
1181
|
+
# glossary). It should be either a valid IPv4 address or a fully-qualified
|
|
1182
|
+
# domain name. For example, "8.8.8.8" or "myservice.appspot.com".
|
|
1338
1183
|
# Corresponds to the JSON property `target`
|
|
1339
1184
|
# @return [String]
|
|
1340
1185
|
attr_accessor :target
|
|
@@ -1371,8 +1216,8 @@ module Google
|
|
|
1371
1216
|
# @return [Array<Google::Apis::ServiceusageV1beta1::Option>]
|
|
1372
1217
|
attr_accessor :options
|
|
1373
1218
|
|
|
1374
|
-
# `SourceContext` represents information about the source of a
|
|
1375
|
-
#
|
|
1219
|
+
# `SourceContext` represents information about the source of a protobuf element,
|
|
1220
|
+
# like the file in which it is defined.
|
|
1376
1221
|
# Corresponds to the JSON property `sourceContext`
|
|
1377
1222
|
# @return [Google::Apis::ServiceusageV1beta1::SourceContext]
|
|
1378
1223
|
attr_accessor :source_context
|
|
@@ -1461,8 +1306,8 @@ module Google
|
|
|
1461
1306
|
# @return [Fixnum]
|
|
1462
1307
|
attr_accessor :number
|
|
1463
1308
|
|
|
1464
|
-
# The index of the field type in `Type.oneofs`, for message or enumeration
|
|
1465
|
-
#
|
|
1309
|
+
# The index of the field type in `Type.oneofs`, for message or enumeration types.
|
|
1310
|
+
# The first type has index 1; zero means the type is not in the list.
|
|
1466
1311
|
# Corresponds to the JSON property `oneofIndex`
|
|
1467
1312
|
# @return [Fixnum]
|
|
1468
1313
|
attr_accessor :oneof_index
|
|
@@ -1478,8 +1323,8 @@ module Google
|
|
|
1478
1323
|
attr_accessor :packed
|
|
1479
1324
|
alias_method :packed?, :packed
|
|
1480
1325
|
|
|
1481
|
-
# The field type URL, without the scheme, for message or enumeration
|
|
1482
|
-
#
|
|
1326
|
+
# The field type URL, without the scheme, for message or enumeration types.
|
|
1327
|
+
# Example: `"type.googleapis.com/google.protobuf.Timestamp"`.
|
|
1483
1328
|
# Corresponds to the JSON property `typeUrl`
|
|
1484
1329
|
# @return [String]
|
|
1485
1330
|
attr_accessor :type_url
|
|
@@ -1530,50 +1375,32 @@ module Google
|
|
|
1530
1375
|
end
|
|
1531
1376
|
|
|
1532
1377
|
# `Service` is the root object of Google service configuration schema. It
|
|
1533
|
-
# describes basic information about a service, such as the name and the
|
|
1534
|
-
#
|
|
1535
|
-
#
|
|
1536
|
-
#
|
|
1537
|
-
#
|
|
1538
|
-
#
|
|
1539
|
-
#
|
|
1540
|
-
#
|
|
1541
|
-
#
|
|
1542
|
-
# apis:
|
|
1543
|
-
# - name: google.calendar.v3.Calendar
|
|
1544
|
-
# authentication:
|
|
1545
|
-
# providers:
|
|
1546
|
-
# - id: google_calendar_auth
|
|
1547
|
-
# jwks_uri: https://www.googleapis.com/oauth2/v1/certs
|
|
1548
|
-
# issuer: https://securetoken.google.com
|
|
1549
|
-
# rules:
|
|
1550
|
-
# - selector: "*"
|
|
1551
|
-
# requirements:
|
|
1552
|
-
# provider_id: google_calendar_auth
|
|
1378
|
+
# describes basic information about a service, such as the name and the title,
|
|
1379
|
+
# and delegates other aspects to sub-sections. Each sub-section is either a
|
|
1380
|
+
# proto message or a repeated proto message that configures a specific aspect,
|
|
1381
|
+
# such as auth. See each proto message definition for details. Example: type:
|
|
1382
|
+
# google.api.Service config_version: 3 name: calendar.googleapis.com title:
|
|
1383
|
+
# Google Calendar API apis: - name: google.calendar.v3.Calendar authentication:
|
|
1384
|
+
# providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/
|
|
1385
|
+
# oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: "*"
|
|
1386
|
+
# requirements: provider_id: google_calendar_auth
|
|
1553
1387
|
class GoogleApiService
|
|
1554
1388
|
include Google::Apis::Core::Hashable
|
|
1555
1389
|
|
|
1556
|
-
# A list of API interfaces exported by this service. Only the `name` field
|
|
1557
|
-
#
|
|
1558
|
-
#
|
|
1559
|
-
#
|
|
1560
|
-
#
|
|
1390
|
+
# A list of API interfaces exported by this service. Only the `name` field of
|
|
1391
|
+
# the google.protobuf.Api needs to be provided by the configuration author, as
|
|
1392
|
+
# the remaining fields will be derived from the IDL during the normalization
|
|
1393
|
+
# process. It is an error to specify an API interface here which cannot be
|
|
1394
|
+
# resolved against the associated IDL files.
|
|
1561
1395
|
# Corresponds to the JSON property `apis`
|
|
1562
1396
|
# @return [Array<Google::Apis::ServiceusageV1beta1::Api>]
|
|
1563
1397
|
attr_accessor :apis
|
|
1564
1398
|
|
|
1565
|
-
# `Authentication` defines the authentication configuration for an API.
|
|
1566
|
-
#
|
|
1567
|
-
#
|
|
1568
|
-
#
|
|
1569
|
-
#
|
|
1570
|
-
# - id: google_calendar_auth
|
|
1571
|
-
# jwks_uri: https://www.googleapis.com/oauth2/v1/certs
|
|
1572
|
-
# issuer: https://securetoken.google.com
|
|
1573
|
-
# rules:
|
|
1574
|
-
# - selector: "*"
|
|
1575
|
-
# requirements:
|
|
1576
|
-
# provider_id: google_calendar_auth
|
|
1399
|
+
# `Authentication` defines the authentication configuration for an API. Example
|
|
1400
|
+
# for an API targeted for external use: name: calendar.googleapis.com
|
|
1401
|
+
# authentication: providers: - id: google_calendar_auth jwks_uri: https://www.
|
|
1402
|
+
# googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: -
|
|
1403
|
+
# selector: "*" requirements: provider_id: google_calendar_auth
|
|
1577
1404
|
# Corresponds to the JSON property `authentication`
|
|
1578
1405
|
# @return [Google::Apis::ServiceusageV1beta1::Authentication]
|
|
1579
1406
|
attr_accessor :authentication
|
|
@@ -1583,211 +1410,136 @@ module Google
|
|
|
1583
1410
|
# @return [Google::Apis::ServiceusageV1beta1::Backend]
|
|
1584
1411
|
attr_accessor :backend
|
|
1585
1412
|
|
|
1586
|
-
# Billing related configuration of the service.
|
|
1587
|
-
#
|
|
1588
|
-
#
|
|
1589
|
-
#
|
|
1590
|
-
#
|
|
1591
|
-
#
|
|
1592
|
-
#
|
|
1593
|
-
#
|
|
1594
|
-
# -
|
|
1595
|
-
#
|
|
1596
|
-
# - key:
|
|
1597
|
-
#
|
|
1598
|
-
#
|
|
1599
|
-
# -
|
|
1600
|
-
#
|
|
1601
|
-
# Custom label to define the city where the library branch is located
|
|
1602
|
-
# in.
|
|
1603
|
-
# - key: name
|
|
1604
|
-
# description: Custom label to define the name of the library branch.
|
|
1605
|
-
# metrics:
|
|
1606
|
-
# - name: library.googleapis.com/book/borrowed_count
|
|
1607
|
-
# metric_kind: DELTA
|
|
1608
|
-
# value_type: INT64
|
|
1609
|
-
# unit: "1"
|
|
1610
|
-
# billing:
|
|
1611
|
-
# consumer_destinations:
|
|
1612
|
-
# - monitored_resource: library.googleapis.com/billing_branch
|
|
1613
|
-
# metrics:
|
|
1614
|
-
# - library.googleapis.com/book/borrowed_count
|
|
1413
|
+
# Billing related configuration of the service. The following example shows how
|
|
1414
|
+
# to configure monitored resources and metrics for billing, `
|
|
1415
|
+
# consumer_destinations` is the only supported destination and the monitored
|
|
1416
|
+
# resources need at least one label key `cloud.googleapis.com/location` to
|
|
1417
|
+
# indicate the location of the billing usage, using different monitored
|
|
1418
|
+
# resources between monitoring and billing is recommended so they can be evolved
|
|
1419
|
+
# independently: monitored_resources: - type: library.googleapis.com/
|
|
1420
|
+
# billing_branch labels: - key: cloud.googleapis.com/location description: |
|
|
1421
|
+
# Predefined label to support billing location restriction. - key: city
|
|
1422
|
+
# description: | Custom label to define the city where the library branch is
|
|
1423
|
+
# located in. - key: name description: Custom label to define the name of the
|
|
1424
|
+
# library branch. metrics: - name: library.googleapis.com/book/borrowed_count
|
|
1425
|
+
# metric_kind: DELTA value_type: INT64 unit: "1" billing: consumer_destinations:
|
|
1426
|
+
# - monitored_resource: library.googleapis.com/billing_branch metrics: - library.
|
|
1427
|
+
# googleapis.com/book/borrowed_count
|
|
1615
1428
|
# Corresponds to the JSON property `billing`
|
|
1616
1429
|
# @return [Google::Apis::ServiceusageV1beta1::Billing]
|
|
1617
1430
|
attr_accessor :billing
|
|
1618
1431
|
|
|
1619
|
-
# The semantic version of the service configuration. The config version
|
|
1620
|
-
#
|
|
1621
|
-
#
|
|
1622
|
-
#
|
|
1432
|
+
# The semantic version of the service configuration. The config version affects
|
|
1433
|
+
# the interpretation of the service configuration. For example, certain features
|
|
1434
|
+
# are enabled by default for certain config versions. The latest config version
|
|
1435
|
+
# is `3`.
|
|
1623
1436
|
# Corresponds to the JSON property `configVersion`
|
|
1624
1437
|
# @return [Fixnum]
|
|
1625
1438
|
attr_accessor :config_version
|
|
1626
1439
|
|
|
1627
|
-
# `Context` defines which contexts an API requests.
|
|
1628
|
-
#
|
|
1629
|
-
# context
|
|
1630
|
-
#
|
|
1631
|
-
#
|
|
1632
|
-
#
|
|
1633
|
-
# -
|
|
1634
|
-
#
|
|
1635
|
-
#
|
|
1636
|
-
#
|
|
1637
|
-
#
|
|
1638
|
-
#
|
|
1639
|
-
#
|
|
1640
|
-
# This also provides mechanism to whitelist any protobuf message extension that
|
|
1641
|
-
# can be sent in grpc metadata using “x-goog-ext-<extension_id>-bin” and
|
|
1642
|
-
# “x-goog-ext-<extension_id>-jspb” format. For example, list any service
|
|
1643
|
-
# specific protobuf types that can appear in grpc metadata as follows in your
|
|
1644
|
-
# yaml file:
|
|
1645
|
-
# Example:
|
|
1646
|
-
# context:
|
|
1647
|
-
# rules:
|
|
1648
|
-
# - selector: "google.example.library.v1.LibraryService.CreateBook"
|
|
1649
|
-
# allowed_request_extensions:
|
|
1650
|
-
# - google.foo.v1.NewExtension
|
|
1651
|
-
# allowed_response_extensions:
|
|
1652
|
-
# - google.foo.v1.NewExtension
|
|
1653
|
-
# You can also specify extension ID instead of fully qualified extension name
|
|
1654
|
-
# here.
|
|
1440
|
+
# `Context` defines which contexts an API requests. Example: context: rules: -
|
|
1441
|
+
# selector: "*" requested: - google.rpc.context.ProjectContext - google.rpc.
|
|
1442
|
+
# context.OriginContext The above specifies that all methods in the API request `
|
|
1443
|
+
# google.rpc.context.ProjectContext` and `google.rpc.context.OriginContext`.
|
|
1444
|
+
# Available context types are defined in package `google.rpc.context`. This also
|
|
1445
|
+
# provides mechanism to whitelist any protobuf message extension that can be
|
|
1446
|
+
# sent in grpc metadata using “x-goog-ext--bin” and “x-goog-ext--jspb” format.
|
|
1447
|
+
# For example, list any service specific protobuf types that can appear in grpc
|
|
1448
|
+
# metadata as follows in your yaml file: Example: context: rules: - selector: "
|
|
1449
|
+
# google.example.library.v1.LibraryService.CreateBook"
|
|
1450
|
+
# allowed_request_extensions: - google.foo.v1.NewExtension
|
|
1451
|
+
# allowed_response_extensions: - google.foo.v1.NewExtension You can also specify
|
|
1452
|
+
# extension ID instead of fully qualified extension name here.
|
|
1655
1453
|
# Corresponds to the JSON property `context`
|
|
1656
1454
|
# @return [Google::Apis::ServiceusageV1beta1::Context]
|
|
1657
1455
|
attr_accessor :context
|
|
1658
1456
|
|
|
1659
|
-
# Selects and configures the service controller used by the service.
|
|
1660
|
-
#
|
|
1661
|
-
#
|
|
1457
|
+
# Selects and configures the service controller used by the service. The service
|
|
1458
|
+
# controller handles features like abuse, quota, billing, logging, monitoring,
|
|
1459
|
+
# etc.
|
|
1662
1460
|
# Corresponds to the JSON property `control`
|
|
1663
1461
|
# @return [Google::Apis::ServiceusageV1beta1::Control]
|
|
1664
1462
|
attr_accessor :control
|
|
1665
1463
|
|
|
1666
|
-
# Customize service error responses.
|
|
1667
|
-
#
|
|
1668
|
-
#
|
|
1669
|
-
#
|
|
1670
|
-
# custom_error:
|
|
1671
|
-
# types:
|
|
1672
|
-
# - google.foo.v1.CustomError
|
|
1673
|
-
# - google.foo.v1.AnotherError
|
|
1464
|
+
# Customize service error responses. For example, list any service specific
|
|
1465
|
+
# protobuf types that can appear in error detail lists of error responses.
|
|
1466
|
+
# Example: custom_error: types: - google.foo.v1.CustomError - google.foo.v1.
|
|
1467
|
+
# AnotherError
|
|
1674
1468
|
# Corresponds to the JSON property `customError`
|
|
1675
1469
|
# @return [Google::Apis::ServiceusageV1beta1::CustomError]
|
|
1676
1470
|
attr_accessor :custom_error
|
|
1677
1471
|
|
|
1678
|
-
# `Documentation` provides the information for describing a service.
|
|
1679
|
-
#
|
|
1680
|
-
#
|
|
1681
|
-
#
|
|
1682
|
-
#
|
|
1683
|
-
#
|
|
1684
|
-
#
|
|
1685
|
-
#
|
|
1686
|
-
#
|
|
1687
|
-
#
|
|
1688
|
-
#
|
|
1689
|
-
#
|
|
1690
|
-
#
|
|
1691
|
-
#
|
|
1692
|
-
#
|
|
1693
|
-
#
|
|
1694
|
-
#
|
|
1695
|
-
#
|
|
1696
|
-
#
|
|
1697
|
-
#
|
|
1698
|
-
#
|
|
1699
|
-
#
|
|
1700
|
-
#
|
|
1701
|
-
#
|
|
1702
|
-
#
|
|
1703
|
-
#
|
|
1704
|
-
# a documentation fragment is embedded.
|
|
1705
|
-
# Documentation from the IDL is merged with documentation defined
|
|
1706
|
-
# via the config at normalization time, where documentation provided
|
|
1707
|
-
# by config rules overrides IDL provided.
|
|
1708
|
-
# A number of constructs specific to the API platform are supported
|
|
1709
|
-
# in documentation text.
|
|
1710
|
-
# In order to reference a proto element, the following
|
|
1711
|
-
# notation can be used:
|
|
1712
|
-
# <pre><code>[fully.qualified.proto.name][]</code></pre>
|
|
1713
|
-
# To override the display text used for the link, this can be used:
|
|
1714
|
-
# <pre><code>[display text][fully.qualified.proto.name]</code></pre>
|
|
1715
|
-
# Text can be excluded from doc using the following notation:
|
|
1716
|
-
# <pre><code>(-- internal comment --)</code></pre>
|
|
1717
|
-
# A few directives are available in documentation. Note that
|
|
1718
|
-
# directives must appear on a single line to be properly
|
|
1719
|
-
# identified. The `include` directive includes a markdown file from
|
|
1720
|
-
# an external source:
|
|
1721
|
-
# <pre><code>(== include path/to/file ==)</code></pre>
|
|
1722
|
-
# The `resource_for` directive marks a message to be the resource of
|
|
1723
|
-
# a collection in REST view. If it is not specified, tools attempt
|
|
1724
|
-
# to infer the resource from the operations in a collection:
|
|
1725
|
-
# <pre><code>(== resource_for v1.shelves.books ==)</code></pre>
|
|
1726
|
-
# The directive `suppress_warning` does not directly affect documentation
|
|
1727
|
-
# and is documented together with service config validation.
|
|
1472
|
+
# `Documentation` provides the information for describing a service. Example:
|
|
1473
|
+
# documentation: summary: > The Google Calendar API gives access to most
|
|
1474
|
+
# calendar features. pages: - name: Overview content: (== include google/foo/
|
|
1475
|
+
# overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==
|
|
1476
|
+
# ) subpages; - name: Java content: (== include google/foo/tutorial_java.md ==)
|
|
1477
|
+
# rules: - selector: google.calendar.Calendar.Get description: > ... - selector:
|
|
1478
|
+
# google.calendar.Calendar.Put description: > ... Documentation is provided in
|
|
1479
|
+
# markdown syntax. In addition to standard markdown features, definition lists,
|
|
1480
|
+
# tables and fenced code blocks are supported. Section headers can be provided
|
|
1481
|
+
# and are interpreted relative to the section nesting of the context where a
|
|
1482
|
+
# documentation fragment is embedded. Documentation from the IDL is merged with
|
|
1483
|
+
# documentation defined via the config at normalization time, where
|
|
1484
|
+
# documentation provided by config rules overrides IDL provided. A number of
|
|
1485
|
+
# constructs specific to the API platform are supported in documentation text.
|
|
1486
|
+
# In order to reference a proto element, the following notation can be used: [
|
|
1487
|
+
# fully.qualified.proto.name][] To override the display text used for the link,
|
|
1488
|
+
# this can be used: [display text][fully.qualified.proto.name] Text can be
|
|
1489
|
+
# excluded from doc using the following notation: (-- internal comment --) A few
|
|
1490
|
+
# directives are available in documentation. Note that directives must appear on
|
|
1491
|
+
# a single line to be properly identified. The `include` directive includes a
|
|
1492
|
+
# markdown file from an external source: (== include path/to/file ==) The `
|
|
1493
|
+
# resource_for` directive marks a message to be the resource of a collection in
|
|
1494
|
+
# REST view. If it is not specified, tools attempt to infer the resource from
|
|
1495
|
+
# the operations in a collection: (== resource_for v1.shelves.books ==) The
|
|
1496
|
+
# directive `suppress_warning` does not directly affect documentation and is
|
|
1497
|
+
# documented together with service config validation.
|
|
1728
1498
|
# Corresponds to the JSON property `documentation`
|
|
1729
1499
|
# @return [Google::Apis::ServiceusageV1beta1::Documentation]
|
|
1730
1500
|
attr_accessor :documentation
|
|
1731
1501
|
|
|
1732
|
-
# Configuration for network endpoints.
|
|
1733
|
-
#
|
|
1734
|
-
#
|
|
1502
|
+
# Configuration for network endpoints. If this is empty, then an endpoint with
|
|
1503
|
+
# the same name as the service is automatically generated to service all defined
|
|
1504
|
+
# APIs.
|
|
1735
1505
|
# Corresponds to the JSON property `endpoints`
|
|
1736
1506
|
# @return [Array<Google::Apis::ServiceusageV1beta1::Endpoint>]
|
|
1737
1507
|
attr_accessor :endpoints
|
|
1738
1508
|
|
|
1739
|
-
# A list of all enum types included in this API service.
|
|
1740
|
-
#
|
|
1741
|
-
#
|
|
1742
|
-
#
|
|
1743
|
-
# enums:
|
|
1744
|
-
# - name: google.someapi.v1.SomeEnum
|
|
1509
|
+
# A list of all enum types included in this API service. Enums referenced
|
|
1510
|
+
# directly or indirectly by the `apis` are automatically included. Enums which
|
|
1511
|
+
# are not referenced but shall be included should be listed here by name.
|
|
1512
|
+
# Example: enums: - name: google.someapi.v1.SomeEnum
|
|
1745
1513
|
# Corresponds to the JSON property `enums`
|
|
1746
1514
|
# @return [Array<Google::Apis::ServiceusageV1beta1::Enum>]
|
|
1747
1515
|
attr_accessor :enums
|
|
1748
1516
|
|
|
1749
1517
|
# Defines the HTTP configuration for an API service. It contains a list of
|
|
1750
|
-
# HttpRule, each specifying the mapping of an RPC method
|
|
1751
|
-
#
|
|
1518
|
+
# HttpRule, each specifying the mapping of an RPC method to one or more HTTP
|
|
1519
|
+
# REST API methods.
|
|
1752
1520
|
# Corresponds to the JSON property `http`
|
|
1753
1521
|
# @return [Google::Apis::ServiceusageV1beta1::Http]
|
|
1754
1522
|
attr_accessor :http
|
|
1755
1523
|
|
|
1756
|
-
# A unique ID for a specific instance of this message, typically assigned
|
|
1757
|
-
#
|
|
1758
|
-
#
|
|
1759
|
-
#
|
|
1524
|
+
# A unique ID for a specific instance of this message, typically assigned by the
|
|
1525
|
+
# client for tracking purpose. Must be no longer than 63 characters and only
|
|
1526
|
+
# lower case letters, digits, '.', '_' and '-' are allowed. If empty, the server
|
|
1527
|
+
# may choose to generate one instead.
|
|
1760
1528
|
# Corresponds to the JSON property `id`
|
|
1761
1529
|
# @return [String]
|
|
1762
1530
|
attr_accessor :id
|
|
1763
1531
|
|
|
1764
|
-
# Logging configuration of the service.
|
|
1765
|
-
#
|
|
1766
|
-
#
|
|
1767
|
-
# log is sent to
|
|
1768
|
-
#
|
|
1769
|
-
#
|
|
1770
|
-
# -
|
|
1771
|
-
# labels:
|
|
1772
|
-
# -
|
|
1773
|
-
#
|
|
1774
|
-
#
|
|
1775
|
-
# description: The name of the branch.
|
|
1776
|
-
# logs:
|
|
1777
|
-
# - name: activity_history
|
|
1778
|
-
# labels:
|
|
1779
|
-
# - key: /customer_id
|
|
1780
|
-
# - name: purchase_history
|
|
1781
|
-
# logging:
|
|
1782
|
-
# producer_destinations:
|
|
1783
|
-
# - monitored_resource: library.googleapis.com/branch
|
|
1784
|
-
# logs:
|
|
1785
|
-
# - activity_history
|
|
1786
|
-
# - purchase_history
|
|
1787
|
-
# consumer_destinations:
|
|
1788
|
-
# - monitored_resource: library.googleapis.com/branch
|
|
1789
|
-
# logs:
|
|
1790
|
-
# - activity_history
|
|
1532
|
+
# Logging configuration of the service. The following example shows how to
|
|
1533
|
+
# configure logs to be sent to the producer and consumer projects. In the
|
|
1534
|
+
# example, the `activity_history` log is sent to both the producer and consumer
|
|
1535
|
+
# projects, whereas the `purchase_history` log is only sent to the producer
|
|
1536
|
+
# project. monitored_resources: - type: library.googleapis.com/branch labels: -
|
|
1537
|
+
# key: /city description: The city where the library branch is located in. - key:
|
|
1538
|
+
# /name description: The name of the branch. logs: - name: activity_history
|
|
1539
|
+
# labels: - key: /customer_id - name: purchase_history logging:
|
|
1540
|
+
# producer_destinations: - monitored_resource: library.googleapis.com/branch
|
|
1541
|
+
# logs: - activity_history - purchase_history consumer_destinations: -
|
|
1542
|
+
# monitored_resource: library.googleapis.com/branch logs: - activity_history
|
|
1791
1543
|
# Corresponds to the JSON property `logging`
|
|
1792
1544
|
# @return [Google::Apis::ServiceusageV1beta1::Logging]
|
|
1793
1545
|
attr_accessor :logging
|
|
@@ -1802,70 +1554,41 @@ module Google
|
|
|
1802
1554
|
# @return [Array<Google::Apis::ServiceusageV1beta1::MetricDescriptor>]
|
|
1803
1555
|
attr_accessor :metrics
|
|
1804
1556
|
|
|
1805
|
-
# Defines the monitored resources used by this service. This is required
|
|
1806
|
-
#
|
|
1557
|
+
# Defines the monitored resources used by this service. This is required by the
|
|
1558
|
+
# Service.monitoring and Service.logging configurations.
|
|
1807
1559
|
# Corresponds to the JSON property `monitoredResources`
|
|
1808
1560
|
# @return [Array<Google::Apis::ServiceusageV1beta1::MonitoredResourceDescriptor>]
|
|
1809
1561
|
attr_accessor :monitored_resources
|
|
1810
1562
|
|
|
1811
|
-
# Monitoring configuration of the service.
|
|
1812
|
-
#
|
|
1813
|
-
#
|
|
1814
|
-
#
|
|
1815
|
-
#
|
|
1816
|
-
#
|
|
1817
|
-
#
|
|
1818
|
-
#
|
|
1819
|
-
# -
|
|
1820
|
-
#
|
|
1821
|
-
#
|
|
1822
|
-
#
|
|
1823
|
-
#
|
|
1824
|
-
# - key:
|
|
1825
|
-
#
|
|
1826
|
-
#
|
|
1827
|
-
#
|
|
1828
|
-
#
|
|
1829
|
-
#
|
|
1830
|
-
#
|
|
1831
|
-
#
|
|
1832
|
-
#
|
|
1833
|
-
# description: "The count of books that have been returned."
|
|
1834
|
-
# launch_stage: GA
|
|
1835
|
-
# metric_kind: DELTA
|
|
1836
|
-
# value_type: INT64
|
|
1837
|
-
# unit: "1"
|
|
1838
|
-
# labels:
|
|
1839
|
-
# - key: customer_id
|
|
1840
|
-
# description: "The id of the customer."
|
|
1841
|
-
# - name: library.googleapis.com/book/num_overdue
|
|
1842
|
-
# display_name: "Books Overdue"
|
|
1843
|
-
# description: "The current number of overdue books."
|
|
1844
|
-
# launch_stage: GA
|
|
1845
|
-
# metric_kind: GAUGE
|
|
1846
|
-
# value_type: INT64
|
|
1847
|
-
# unit: "1"
|
|
1848
|
-
# labels:
|
|
1849
|
-
# - key: customer_id
|
|
1850
|
-
# description: "The id of the customer."
|
|
1851
|
-
# monitoring:
|
|
1852
|
-
# producer_destinations:
|
|
1853
|
-
# - monitored_resource: library.googleapis.com/Branch
|
|
1854
|
-
# metrics:
|
|
1855
|
-
# - library.googleapis.com/book/returned_count
|
|
1856
|
-
# consumer_destinations:
|
|
1857
|
-
# - monitored_resource: library.googleapis.com/Branch
|
|
1858
|
-
# metrics:
|
|
1859
|
-
# - library.googleapis.com/book/returned_count
|
|
1860
|
-
# - library.googleapis.com/book/num_overdue
|
|
1563
|
+
# Monitoring configuration of the service. The example below shows how to
|
|
1564
|
+
# configure monitored resources and metrics for monitoring. In the example, a
|
|
1565
|
+
# monitored resource and two metrics are defined. The `library.googleapis.com/
|
|
1566
|
+
# book/returned_count` metric is sent to both producer and consumer projects,
|
|
1567
|
+
# whereas the `library.googleapis.com/book/num_overdue` metric is only sent to
|
|
1568
|
+
# the consumer project. monitored_resources: - type: library.googleapis.com/
|
|
1569
|
+
# Branch display_name: "Library Branch" description: "A branch of a library."
|
|
1570
|
+
# launch_stage: GA labels: - key: resource_container description: "The Cloud
|
|
1571
|
+
# container (ie. project id) for the Branch." - key: location description: "The
|
|
1572
|
+
# location of the library branch." - key: branch_id description: "The id of the
|
|
1573
|
+
# branch." metrics: - name: library.googleapis.com/book/returned_count
|
|
1574
|
+
# display_name: "Books Returned" description: "The count of books that have been
|
|
1575
|
+
# returned." launch_stage: GA metric_kind: DELTA value_type: INT64 unit: "1"
|
|
1576
|
+
# labels: - key: customer_id description: "The id of the customer." - name:
|
|
1577
|
+
# library.googleapis.com/book/num_overdue display_name: "Books Overdue"
|
|
1578
|
+
# description: "The current number of overdue books." launch_stage: GA
|
|
1579
|
+
# metric_kind: GAUGE value_type: INT64 unit: "1" labels: - key: customer_id
|
|
1580
|
+
# description: "The id of the customer." monitoring: producer_destinations: -
|
|
1581
|
+
# monitored_resource: library.googleapis.com/Branch metrics: - library.
|
|
1582
|
+
# googleapis.com/book/returned_count consumer_destinations: - monitored_resource:
|
|
1583
|
+
# library.googleapis.com/Branch metrics: - library.googleapis.com/book/
|
|
1584
|
+
# returned_count - library.googleapis.com/book/num_overdue
|
|
1861
1585
|
# Corresponds to the JSON property `monitoring`
|
|
1862
1586
|
# @return [Google::Apis::ServiceusageV1beta1::Monitoring]
|
|
1863
1587
|
attr_accessor :monitoring
|
|
1864
1588
|
|
|
1865
|
-
# The service name, which is a DNS-like logical identifier for the
|
|
1866
|
-
#
|
|
1867
|
-
#
|
|
1868
|
-
# of the service also owns the DNS name.
|
|
1589
|
+
# The service name, which is a DNS-like logical identifier for the service, such
|
|
1590
|
+
# as `calendar.googleapis.com`. The service name typically goes through DNS
|
|
1591
|
+
# verification to make sure the owner of the service also owns the DNS name.
|
|
1869
1592
|
# Corresponds to the JSON property `name`
|
|
1870
1593
|
# @return [String]
|
|
1871
1594
|
attr_accessor :name
|
|
@@ -1875,46 +1598,25 @@ module Google
|
|
|
1875
1598
|
# @return [String]
|
|
1876
1599
|
attr_accessor :producer_project_id
|
|
1877
1600
|
|
|
1878
|
-
# Quota configuration helps to achieve fairness and budgeting in service
|
|
1879
|
-
#
|
|
1880
|
-
#
|
|
1881
|
-
#
|
|
1882
|
-
#
|
|
1883
|
-
#
|
|
1884
|
-
#
|
|
1885
|
-
#
|
|
1886
|
-
#
|
|
1887
|
-
#
|
|
1888
|
-
#
|
|
1889
|
-
# -
|
|
1890
|
-
#
|
|
1891
|
-
#
|
|
1892
|
-
#
|
|
1893
|
-
#
|
|
1894
|
-
#
|
|
1895
|
-
#
|
|
1896
|
-
#
|
|
1897
|
-
# # consuming at twice rate as the DeleteBook method.
|
|
1898
|
-
# metric_rules:
|
|
1899
|
-
# - selector: "*"
|
|
1900
|
-
# metric_costs:
|
|
1901
|
-
# library.googleapis.com/read_calls: 1
|
|
1902
|
-
# - selector: google.example.library.v1.LibraryService.UpdateBook
|
|
1903
|
-
# metric_costs:
|
|
1904
|
-
# library.googleapis.com/write_calls: 2
|
|
1905
|
-
# - selector: google.example.library.v1.LibraryService.DeleteBook
|
|
1906
|
-
# metric_costs:
|
|
1907
|
-
# library.googleapis.com/write_calls: 1
|
|
1908
|
-
# Corresponding Metric definition:
|
|
1909
|
-
# metrics:
|
|
1910
|
-
# - name: library.googleapis.com/read_calls
|
|
1911
|
-
# display_name: Read requests
|
|
1912
|
-
# metric_kind: DELTA
|
|
1913
|
-
# value_type: INT64
|
|
1914
|
-
# - name: library.googleapis.com/write_calls
|
|
1915
|
-
# display_name: Write requests
|
|
1916
|
-
# metric_kind: DELTA
|
|
1917
|
-
# value_type: INT64
|
|
1601
|
+
# Quota configuration helps to achieve fairness and budgeting in service usage.
|
|
1602
|
+
# The metric based quota configuration works this way: - The service
|
|
1603
|
+
# configuration defines a set of metrics. - For API calls, the quota.
|
|
1604
|
+
# metric_rules maps methods to metrics with corresponding costs. - The quota.
|
|
1605
|
+
# limits defines limits on the metrics, which will be used for quota checks at
|
|
1606
|
+
# runtime. An example quota configuration in yaml format: quota: limits: - name:
|
|
1607
|
+
# apiWriteQpsPerProject metric: library.googleapis.com/write_calls unit: "1/min/`
|
|
1608
|
+
# project`" # rate limit for consumer projects values: STANDARD: 10000 # The
|
|
1609
|
+
# metric rules bind all methods to the read_calls metric, # except for the
|
|
1610
|
+
# UpdateBook and DeleteBook methods. These two methods # are mapped to the
|
|
1611
|
+
# write_calls metric, with the UpdateBook method # consuming at twice rate as
|
|
1612
|
+
# the DeleteBook method. metric_rules: - selector: "*" metric_costs: library.
|
|
1613
|
+
# googleapis.com/read_calls: 1 - selector: google.example.library.v1.
|
|
1614
|
+
# LibraryService.UpdateBook metric_costs: library.googleapis.com/write_calls: 2 -
|
|
1615
|
+
# selector: google.example.library.v1.LibraryService.DeleteBook metric_costs:
|
|
1616
|
+
# library.googleapis.com/write_calls: 1 Corresponding Metric definition: metrics:
|
|
1617
|
+
# - name: library.googleapis.com/read_calls display_name: Read requests
|
|
1618
|
+
# metric_kind: DELTA value_type: INT64 - name: library.googleapis.com/
|
|
1619
|
+
# write_calls display_name: Write requests metric_kind: DELTA value_type: INT64
|
|
1918
1620
|
# Corresponds to the JSON property `quota`
|
|
1919
1621
|
# @return [Google::Apis::ServiceusageV1beta1::Quota]
|
|
1920
1622
|
attr_accessor :quota
|
|
@@ -1924,20 +1626,18 @@ module Google
|
|
|
1924
1626
|
# @return [Google::Apis::ServiceusageV1beta1::SourceInfo]
|
|
1925
1627
|
attr_accessor :source_info
|
|
1926
1628
|
|
|
1927
|
-
# ### System parameter configuration
|
|
1928
|
-
#
|
|
1929
|
-
#
|
|
1930
|
-
#
|
|
1931
|
-
# change the names of the system parameters.
|
|
1629
|
+
# ### System parameter configuration A system parameter is a special kind of
|
|
1630
|
+
# parameter defined by the API system, not by an individual API. It is typically
|
|
1631
|
+
# mapped to an HTTP header and/or a URL query parameter. This configuration
|
|
1632
|
+
# specifies which methods change the names of the system parameters.
|
|
1932
1633
|
# Corresponds to the JSON property `systemParameters`
|
|
1933
1634
|
# @return [Google::Apis::ServiceusageV1beta1::SystemParameters]
|
|
1934
1635
|
attr_accessor :system_parameters
|
|
1935
1636
|
|
|
1936
|
-
# A list of all proto message types included in this API service.
|
|
1937
|
-
#
|
|
1938
|
-
#
|
|
1939
|
-
#
|
|
1940
|
-
# to define system APIs in ESF.
|
|
1637
|
+
# A list of all proto message types included in this API service. It serves
|
|
1638
|
+
# similar purpose as [google.api.Service.types], except that these types are not
|
|
1639
|
+
# needed by user-defined APIs. Therefore, they will not show up in the generated
|
|
1640
|
+
# discovery doc. This field should only be used to define system APIs in ESF.
|
|
1941
1641
|
# Corresponds to the JSON property `systemTypes`
|
|
1942
1642
|
# @return [Array<Google::Apis::ServiceusageV1beta1::Type>]
|
|
1943
1643
|
attr_accessor :system_types
|
|
@@ -1947,12 +1647,10 @@ module Google
|
|
|
1947
1647
|
# @return [String]
|
|
1948
1648
|
attr_accessor :title
|
|
1949
1649
|
|
|
1950
|
-
# A list of all proto message types included in this API service.
|
|
1951
|
-
#
|
|
1952
|
-
#
|
|
1953
|
-
#
|
|
1954
|
-
# should be listed here by name. Example:
|
|
1955
|
-
# types:
|
|
1650
|
+
# A list of all proto message types included in this API service. Types
|
|
1651
|
+
# referenced directly or indirectly by the `apis` are automatically included.
|
|
1652
|
+
# Messages which are not referenced but shall be included, such as types used by
|
|
1653
|
+
# the `google.protobuf.Any` type, should be listed here by name. Example: types:
|
|
1956
1654
|
# - name: google.protobuf.Int32
|
|
1957
1655
|
# Corresponds to the JSON property `types`
|
|
1958
1656
|
# @return [Array<Google::Apis::ServiceusageV1beta1::Type>]
|
|
@@ -1999,32 +1697,28 @@ module Google
|
|
|
1999
1697
|
end
|
|
2000
1698
|
end
|
|
2001
1699
|
|
|
2002
|
-
# The per-product per-project service identity for a service.
|
|
2003
|
-
#
|
|
2004
|
-
#
|
|
2005
|
-
#
|
|
2006
|
-
#
|
|
2007
|
-
# - service_account_parent: "projects/123456789"
|
|
2008
|
-
# display_name: "Cloud XXX Service Agent"
|
|
2009
|
-
# description: "Used as the identity of Cloud XXX to access resources"
|
|
1700
|
+
# The per-product per-project service identity for a service. Use this field to
|
|
1701
|
+
# configure per-product per-project service identity. Example of a service
|
|
1702
|
+
# identity configuration. usage: service_identity: - service_account_parent: "
|
|
1703
|
+
# projects/123456789" display_name: "Cloud XXX Service Agent" description: "Used
|
|
1704
|
+
# as the identity of Cloud XXX to access resources"
|
|
2010
1705
|
class GoogleApiServiceIdentity
|
|
2011
1706
|
include Google::Apis::Core::Hashable
|
|
2012
1707
|
|
|
2013
|
-
# Optional. A user-specified opaque description of the service account.
|
|
2014
|
-
#
|
|
1708
|
+
# Optional. A user-specified opaque description of the service account. Must be
|
|
1709
|
+
# less than or equal to 256 UTF-8 bytes.
|
|
2015
1710
|
# Corresponds to the JSON property `description`
|
|
2016
1711
|
# @return [String]
|
|
2017
1712
|
attr_accessor :description
|
|
2018
1713
|
|
|
2019
|
-
# Optional. A user-specified name for the service account.
|
|
2020
|
-
#
|
|
1714
|
+
# Optional. A user-specified name for the service account. Must be less than or
|
|
1715
|
+
# equal to 100 UTF-8 bytes.
|
|
2021
1716
|
# Corresponds to the JSON property `displayName`
|
|
2022
1717
|
# @return [String]
|
|
2023
1718
|
attr_accessor :display_name
|
|
2024
1719
|
|
|
2025
|
-
# A service account project that hosts the service accounts.
|
|
2026
|
-
#
|
|
2027
|
-
# `projects/123456789`
|
|
1720
|
+
# A service account project that hosts the service accounts. An example name
|
|
1721
|
+
# would be: `projects/123456789`
|
|
2028
1722
|
# Corresponds to the JSON property `serviceAccountParent`
|
|
2029
1723
|
# @return [String]
|
|
2030
1724
|
attr_accessor :service_account_parent
|
|
@@ -2045,8 +1739,7 @@ module Google
|
|
|
2045
1739
|
class GoogleApiServiceusageV1OperationMetadata
|
|
2046
1740
|
include Google::Apis::Core::Hashable
|
|
2047
1741
|
|
|
2048
|
-
# The full name of the resources that this operation is directly
|
|
2049
|
-
# associated with.
|
|
1742
|
+
# The full name of the resources that this operation is directly associated with.
|
|
2050
1743
|
# Corresponds to the JSON property `resourceNames`
|
|
2051
1744
|
# @return [Array<String>]
|
|
2052
1745
|
attr_accessor :resource_names
|
|
@@ -2070,16 +1763,13 @@ module Google
|
|
|
2070
1763
|
# @return [Google::Apis::ServiceusageV1beta1::GoogleApiServiceusageV1ServiceConfig]
|
|
2071
1764
|
attr_accessor :config
|
|
2072
1765
|
|
|
2073
|
-
# The resource name of the consumer and service.
|
|
2074
|
-
#
|
|
2075
|
-
# - projects/123/services/serviceusage.googleapis.com
|
|
1766
|
+
# The resource name of the consumer and service. A valid name would be: -
|
|
1767
|
+
# projects/123/services/serviceusage.googleapis.com
|
|
2076
1768
|
# Corresponds to the JSON property `name`
|
|
2077
1769
|
# @return [String]
|
|
2078
1770
|
attr_accessor :name
|
|
2079
1771
|
|
|
2080
|
-
# The resource name of the consumer.
|
|
2081
|
-
# A valid name would be:
|
|
2082
|
-
# - projects/123
|
|
1772
|
+
# The resource name of the consumer. A valid name would be: - projects/123
|
|
2083
1773
|
# Corresponds to the JSON property `parent`
|
|
2084
1774
|
# @return [String]
|
|
2085
1775
|
attr_accessor :parent
|
|
@@ -2112,129 +1802,76 @@ module Google
|
|
|
2112
1802
|
# @return [Array<Google::Apis::ServiceusageV1beta1::Api>]
|
|
2113
1803
|
attr_accessor :apis
|
|
2114
1804
|
|
|
2115
|
-
# `Authentication` defines the authentication configuration for an API.
|
|
2116
|
-
#
|
|
2117
|
-
#
|
|
2118
|
-
#
|
|
2119
|
-
#
|
|
2120
|
-
# - id: google_calendar_auth
|
|
2121
|
-
# jwks_uri: https://www.googleapis.com/oauth2/v1/certs
|
|
2122
|
-
# issuer: https://securetoken.google.com
|
|
2123
|
-
# rules:
|
|
2124
|
-
# - selector: "*"
|
|
2125
|
-
# requirements:
|
|
2126
|
-
# provider_id: google_calendar_auth
|
|
1805
|
+
# `Authentication` defines the authentication configuration for an API. Example
|
|
1806
|
+
# for an API targeted for external use: name: calendar.googleapis.com
|
|
1807
|
+
# authentication: providers: - id: google_calendar_auth jwks_uri: https://www.
|
|
1808
|
+
# googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: -
|
|
1809
|
+
# selector: "*" requirements: provider_id: google_calendar_auth
|
|
2127
1810
|
# Corresponds to the JSON property `authentication`
|
|
2128
1811
|
# @return [Google::Apis::ServiceusageV1beta1::Authentication]
|
|
2129
1812
|
attr_accessor :authentication
|
|
2130
1813
|
|
|
2131
|
-
# `Documentation` provides the information for describing a service.
|
|
2132
|
-
#
|
|
2133
|
-
#
|
|
2134
|
-
#
|
|
2135
|
-
#
|
|
2136
|
-
#
|
|
2137
|
-
#
|
|
2138
|
-
#
|
|
2139
|
-
#
|
|
2140
|
-
#
|
|
2141
|
-
#
|
|
2142
|
-
#
|
|
2143
|
-
#
|
|
2144
|
-
#
|
|
2145
|
-
#
|
|
2146
|
-
#
|
|
2147
|
-
#
|
|
2148
|
-
#
|
|
2149
|
-
#
|
|
2150
|
-
#
|
|
2151
|
-
#
|
|
2152
|
-
#
|
|
2153
|
-
#
|
|
2154
|
-
#
|
|
2155
|
-
#
|
|
2156
|
-
#
|
|
2157
|
-
# a documentation fragment is embedded.
|
|
2158
|
-
# Documentation from the IDL is merged with documentation defined
|
|
2159
|
-
# via the config at normalization time, where documentation provided
|
|
2160
|
-
# by config rules overrides IDL provided.
|
|
2161
|
-
# A number of constructs specific to the API platform are supported
|
|
2162
|
-
# in documentation text.
|
|
2163
|
-
# In order to reference a proto element, the following
|
|
2164
|
-
# notation can be used:
|
|
2165
|
-
# <pre><code>[fully.qualified.proto.name][]</code></pre>
|
|
2166
|
-
# To override the display text used for the link, this can be used:
|
|
2167
|
-
# <pre><code>[display text][fully.qualified.proto.name]</code></pre>
|
|
2168
|
-
# Text can be excluded from doc using the following notation:
|
|
2169
|
-
# <pre><code>(-- internal comment --)</code></pre>
|
|
2170
|
-
# A few directives are available in documentation. Note that
|
|
2171
|
-
# directives must appear on a single line to be properly
|
|
2172
|
-
# identified. The `include` directive includes a markdown file from
|
|
2173
|
-
# an external source:
|
|
2174
|
-
# <pre><code>(== include path/to/file ==)</code></pre>
|
|
2175
|
-
# The `resource_for` directive marks a message to be the resource of
|
|
2176
|
-
# a collection in REST view. If it is not specified, tools attempt
|
|
2177
|
-
# to infer the resource from the operations in a collection:
|
|
2178
|
-
# <pre><code>(== resource_for v1.shelves.books ==)</code></pre>
|
|
2179
|
-
# The directive `suppress_warning` does not directly affect documentation
|
|
2180
|
-
# and is documented together with service config validation.
|
|
1814
|
+
# `Documentation` provides the information for describing a service. Example:
|
|
1815
|
+
# documentation: summary: > The Google Calendar API gives access to most
|
|
1816
|
+
# calendar features. pages: - name: Overview content: (== include google/foo/
|
|
1817
|
+
# overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==
|
|
1818
|
+
# ) subpages; - name: Java content: (== include google/foo/tutorial_java.md ==)
|
|
1819
|
+
# rules: - selector: google.calendar.Calendar.Get description: > ... - selector:
|
|
1820
|
+
# google.calendar.Calendar.Put description: > ... Documentation is provided in
|
|
1821
|
+
# markdown syntax. In addition to standard markdown features, definition lists,
|
|
1822
|
+
# tables and fenced code blocks are supported. Section headers can be provided
|
|
1823
|
+
# and are interpreted relative to the section nesting of the context where a
|
|
1824
|
+
# documentation fragment is embedded. Documentation from the IDL is merged with
|
|
1825
|
+
# documentation defined via the config at normalization time, where
|
|
1826
|
+
# documentation provided by config rules overrides IDL provided. A number of
|
|
1827
|
+
# constructs specific to the API platform are supported in documentation text.
|
|
1828
|
+
# In order to reference a proto element, the following notation can be used: [
|
|
1829
|
+
# fully.qualified.proto.name][] To override the display text used for the link,
|
|
1830
|
+
# this can be used: [display text][fully.qualified.proto.name] Text can be
|
|
1831
|
+
# excluded from doc using the following notation: (-- internal comment --) A few
|
|
1832
|
+
# directives are available in documentation. Note that directives must appear on
|
|
1833
|
+
# a single line to be properly identified. The `include` directive includes a
|
|
1834
|
+
# markdown file from an external source: (== include path/to/file ==) The `
|
|
1835
|
+
# resource_for` directive marks a message to be the resource of a collection in
|
|
1836
|
+
# REST view. If it is not specified, tools attempt to infer the resource from
|
|
1837
|
+
# the operations in a collection: (== resource_for v1.shelves.books ==) The
|
|
1838
|
+
# directive `suppress_warning` does not directly affect documentation and is
|
|
1839
|
+
# documented together with service config validation.
|
|
2181
1840
|
# Corresponds to the JSON property `documentation`
|
|
2182
1841
|
# @return [Google::Apis::ServiceusageV1beta1::Documentation]
|
|
2183
1842
|
attr_accessor :documentation
|
|
2184
1843
|
|
|
2185
|
-
# Configuration for network endpoints. Contains only the names and aliases
|
|
2186
|
-
#
|
|
1844
|
+
# Configuration for network endpoints. Contains only the names and aliases of
|
|
1845
|
+
# the endpoints.
|
|
2187
1846
|
# Corresponds to the JSON property `endpoints`
|
|
2188
1847
|
# @return [Array<Google::Apis::ServiceusageV1beta1::Endpoint>]
|
|
2189
1848
|
attr_accessor :endpoints
|
|
2190
1849
|
|
|
2191
|
-
# The DNS address at which this service is available.
|
|
2192
|
-
#
|
|
2193
|
-
# `calendar.googleapis.com`.
|
|
1850
|
+
# The DNS address at which this service is available. An example DNS address
|
|
1851
|
+
# would be: `calendar.googleapis.com`.
|
|
2194
1852
|
# Corresponds to the JSON property `name`
|
|
2195
1853
|
# @return [String]
|
|
2196
1854
|
attr_accessor :name
|
|
2197
1855
|
|
|
2198
|
-
# Quota configuration helps to achieve fairness and budgeting in service
|
|
2199
|
-
#
|
|
2200
|
-
#
|
|
2201
|
-
#
|
|
2202
|
-
#
|
|
2203
|
-
#
|
|
2204
|
-
#
|
|
2205
|
-
#
|
|
2206
|
-
#
|
|
2207
|
-
#
|
|
2208
|
-
#
|
|
2209
|
-
# -
|
|
2210
|
-
#
|
|
2211
|
-
#
|
|
2212
|
-
#
|
|
2213
|
-
#
|
|
2214
|
-
#
|
|
2215
|
-
#
|
|
2216
|
-
#
|
|
2217
|
-
# # consuming at twice rate as the DeleteBook method.
|
|
2218
|
-
# metric_rules:
|
|
2219
|
-
# - selector: "*"
|
|
2220
|
-
# metric_costs:
|
|
2221
|
-
# library.googleapis.com/read_calls: 1
|
|
2222
|
-
# - selector: google.example.library.v1.LibraryService.UpdateBook
|
|
2223
|
-
# metric_costs:
|
|
2224
|
-
# library.googleapis.com/write_calls: 2
|
|
2225
|
-
# - selector: google.example.library.v1.LibraryService.DeleteBook
|
|
2226
|
-
# metric_costs:
|
|
2227
|
-
# library.googleapis.com/write_calls: 1
|
|
2228
|
-
# Corresponding Metric definition:
|
|
2229
|
-
# metrics:
|
|
2230
|
-
# - name: library.googleapis.com/read_calls
|
|
2231
|
-
# display_name: Read requests
|
|
2232
|
-
# metric_kind: DELTA
|
|
2233
|
-
# value_type: INT64
|
|
2234
|
-
# - name: library.googleapis.com/write_calls
|
|
2235
|
-
# display_name: Write requests
|
|
2236
|
-
# metric_kind: DELTA
|
|
2237
|
-
# value_type: INT64
|
|
1856
|
+
# Quota configuration helps to achieve fairness and budgeting in service usage.
|
|
1857
|
+
# The metric based quota configuration works this way: - The service
|
|
1858
|
+
# configuration defines a set of metrics. - For API calls, the quota.
|
|
1859
|
+
# metric_rules maps methods to metrics with corresponding costs. - The quota.
|
|
1860
|
+
# limits defines limits on the metrics, which will be used for quota checks at
|
|
1861
|
+
# runtime. An example quota configuration in yaml format: quota: limits: - name:
|
|
1862
|
+
# apiWriteQpsPerProject metric: library.googleapis.com/write_calls unit: "1/min/`
|
|
1863
|
+
# project`" # rate limit for consumer projects values: STANDARD: 10000 # The
|
|
1864
|
+
# metric rules bind all methods to the read_calls metric, # except for the
|
|
1865
|
+
# UpdateBook and DeleteBook methods. These two methods # are mapped to the
|
|
1866
|
+
# write_calls metric, with the UpdateBook method # consuming at twice rate as
|
|
1867
|
+
# the DeleteBook method. metric_rules: - selector: "*" metric_costs: library.
|
|
1868
|
+
# googleapis.com/read_calls: 1 - selector: google.example.library.v1.
|
|
1869
|
+
# LibraryService.UpdateBook metric_costs: library.googleapis.com/write_calls: 2 -
|
|
1870
|
+
# selector: google.example.library.v1.LibraryService.DeleteBook metric_costs:
|
|
1871
|
+
# library.googleapis.com/write_calls: 1 Corresponding Metric definition: metrics:
|
|
1872
|
+
# - name: library.googleapis.com/read_calls display_name: Read requests
|
|
1873
|
+
# metric_kind: DELTA value_type: INT64 - name: library.googleapis.com/
|
|
1874
|
+
# write_calls display_name: Write requests metric_kind: DELTA value_type: INT64
|
|
2238
1875
|
# Corresponds to the JSON property `quota`
|
|
2239
1876
|
# @return [Google::Apis::ServiceusageV1beta1::Quota]
|
|
2240
1877
|
attr_accessor :quota
|
|
@@ -2297,15 +1934,14 @@ module Google
|
|
|
2297
1934
|
class GoogleApiServiceusageV1beta1ServiceIdentity
|
|
2298
1935
|
include Google::Apis::Core::Hashable
|
|
2299
1936
|
|
|
2300
|
-
# The email address of the service account that a service producer would use
|
|
2301
|
-
#
|
|
1937
|
+
# The email address of the service account that a service producer would use to
|
|
1938
|
+
# access consumer resources.
|
|
2302
1939
|
# Corresponds to the JSON property `email`
|
|
2303
1940
|
# @return [String]
|
|
2304
1941
|
attr_accessor :email
|
|
2305
1942
|
|
|
2306
|
-
# The unique and stable id of the service account.
|
|
2307
|
-
#
|
|
2308
|
-
# ServiceAccount
|
|
1943
|
+
# The unique and stable id of the service account. https://cloud.google.com/iam/
|
|
1944
|
+
# reference/rest/v1/projects.serviceAccounts#ServiceAccount
|
|
2309
1945
|
# Corresponds to the JSON property `uniqueId`
|
|
2310
1946
|
# @return [String]
|
|
2311
1947
|
attr_accessor :unique_id
|
|
@@ -2322,23 +1958,22 @@ module Google
|
|
|
2322
1958
|
end
|
|
2323
1959
|
|
|
2324
1960
|
# Defines the HTTP configuration for an API service. It contains a list of
|
|
2325
|
-
# HttpRule, each specifying the mapping of an RPC method
|
|
2326
|
-
#
|
|
1961
|
+
# HttpRule, each specifying the mapping of an RPC method to one or more HTTP
|
|
1962
|
+
# REST API methods.
|
|
2327
1963
|
class Http
|
|
2328
1964
|
include Google::Apis::Core::Hashable
|
|
2329
1965
|
|
|
2330
1966
|
# When set to true, URL path parameters will be fully URI-decoded except in
|
|
2331
1967
|
# cases of single segment matches in reserved expansion, where "%2F" will be
|
|
2332
|
-
# left encoded.
|
|
2333
|
-
#
|
|
2334
|
-
# segment matches.
|
|
1968
|
+
# left encoded. The default behavior is to not decode RFC 6570 reserved
|
|
1969
|
+
# characters in multi segment matches.
|
|
2335
1970
|
# Corresponds to the JSON property `fullyDecodeReservedExpansion`
|
|
2336
1971
|
# @return [Boolean]
|
|
2337
1972
|
attr_accessor :fully_decode_reserved_expansion
|
|
2338
1973
|
alias_method :fully_decode_reserved_expansion?, :fully_decode_reserved_expansion
|
|
2339
1974
|
|
|
2340
|
-
# A list of HTTP configuration rules that apply to individual API methods.
|
|
2341
|
-
#
|
|
1975
|
+
# A list of HTTP configuration rules that apply to individual API methods. **
|
|
1976
|
+
# NOTE:** All service configuration rules follow "last one wins" order.
|
|
2342
1977
|
# Corresponds to the JSON property `rules`
|
|
2343
1978
|
# @return [Array<Google::Apis::ServiceusageV1beta1::HttpRule>]
|
|
2344
1979
|
attr_accessor :rules
|
|
@@ -2354,251 +1989,156 @@ module Google
|
|
|
2354
1989
|
end
|
|
2355
1990
|
end
|
|
2356
1991
|
|
|
2357
|
-
# # gRPC Transcoding
|
|
2358
|
-
#
|
|
2359
|
-
#
|
|
2360
|
-
#
|
|
2361
|
-
#
|
|
2362
|
-
# [
|
|
2363
|
-
#
|
|
2364
|
-
#
|
|
2365
|
-
#
|
|
2366
|
-
#
|
|
2367
|
-
#
|
|
2368
|
-
# path, URL query parameters, and HTTP request body. It also controls how the
|
|
2369
|
-
# gRPC response message is mapped to the HTTP response body. `HttpRule` is
|
|
1992
|
+
# # gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC
|
|
1993
|
+
# method and one or more HTTP REST endpoints. It allows developers to build a
|
|
1994
|
+
# single API service that supports both gRPC APIs and REST APIs. Many systems,
|
|
1995
|
+
# including [Google APIs](https://github.com/googleapis/googleapis), [Cloud
|
|
1996
|
+
# Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.
|
|
1997
|
+
# com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/
|
|
1998
|
+
# envoy) proxy support this feature and use it for large scale production
|
|
1999
|
+
# services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping
|
|
2000
|
+
# specifies how different portions of the gRPC request message are mapped to the
|
|
2001
|
+
# URL path, URL query parameters, and HTTP request body. It also controls how
|
|
2002
|
+
# the gRPC response message is mapped to the HTTP response body. `HttpRule` is
|
|
2370
2003
|
# typically specified as an `google.api.http` annotation on the gRPC method.
|
|
2371
2004
|
# Each mapping specifies a URL path template and an HTTP method. The path
|
|
2372
2005
|
# template may refer to one or more fields in the gRPC request message, as long
|
|
2373
|
-
# as each field is a non-repeated field with a primitive (non-message) type.
|
|
2374
|
-
#
|
|
2375
|
-
#
|
|
2376
|
-
#
|
|
2377
|
-
#
|
|
2378
|
-
#
|
|
2379
|
-
#
|
|
2380
|
-
#
|
|
2381
|
-
#
|
|
2382
|
-
#
|
|
2383
|
-
# `
|
|
2384
|
-
#
|
|
2385
|
-
# string
|
|
2386
|
-
#
|
|
2387
|
-
#
|
|
2388
|
-
#
|
|
2389
|
-
# `
|
|
2390
|
-
#
|
|
2391
|
-
#
|
|
2392
|
-
#
|
|
2393
|
-
#
|
|
2394
|
-
#
|
|
2395
|
-
#
|
|
2396
|
-
#
|
|
2397
|
-
#
|
|
2398
|
-
# rpc
|
|
2399
|
-
#
|
|
2400
|
-
#
|
|
2401
|
-
#
|
|
2402
|
-
#
|
|
2403
|
-
# `
|
|
2404
|
-
#
|
|
2405
|
-
# message
|
|
2406
|
-
#
|
|
2407
|
-
#
|
|
2408
|
-
#
|
|
2409
|
-
#
|
|
2410
|
-
#
|
|
2411
|
-
# `
|
|
2412
|
-
#
|
|
2413
|
-
#
|
|
2414
|
-
#
|
|
2415
|
-
#
|
|
2416
|
-
#
|
|
2417
|
-
#
|
|
2418
|
-
#
|
|
2419
|
-
#
|
|
2420
|
-
#
|
|
2421
|
-
#
|
|
2422
|
-
#
|
|
2423
|
-
#
|
|
2424
|
-
#
|
|
2425
|
-
#
|
|
2426
|
-
#
|
|
2427
|
-
#
|
|
2428
|
-
#
|
|
2429
|
-
#
|
|
2430
|
-
#
|
|
2431
|
-
#
|
|
2432
|
-
#
|
|
2433
|
-
#
|
|
2434
|
-
#
|
|
2435
|
-
#
|
|
2436
|
-
#
|
|
2437
|
-
#
|
|
2438
|
-
# `
|
|
2439
|
-
# The
|
|
2440
|
-
#
|
|
2441
|
-
#
|
|
2442
|
-
#
|
|
2443
|
-
#
|
|
2444
|
-
#
|
|
2445
|
-
#
|
|
2446
|
-
#
|
|
2447
|
-
#
|
|
2448
|
-
#
|
|
2449
|
-
# the
|
|
2450
|
-
#
|
|
2451
|
-
#
|
|
2452
|
-
#
|
|
2453
|
-
#
|
|
2454
|
-
#
|
|
2455
|
-
#
|
|
2456
|
-
#
|
|
2457
|
-
#
|
|
2458
|
-
#
|
|
2459
|
-
#
|
|
2460
|
-
#
|
|
2461
|
-
# `
|
|
2462
|
-
# The following HTTP JSON to RPC mapping is enabled:
|
|
2463
|
-
# HTTP | gRPC
|
|
2464
|
-
# -----|-----
|
|
2465
|
-
# `PATCH /v1/messages/123456 ` "text": "Hi!" `` | `UpdateMessage(message_id:
|
|
2466
|
-
# "123456" text: "Hi!")`
|
|
2467
|
-
# Note that when using `*` in the body mapping, it is not possible to
|
|
2468
|
-
# have HTTP parameters, as all fields not bound by the path end in
|
|
2469
|
-
# the body. This makes this option more rarely used in practice when
|
|
2470
|
-
# defining REST APIs. The common usage of `*` is in custom methods
|
|
2471
|
-
# which don't use the URL at all for transferring data.
|
|
2472
|
-
# It is possible to define multiple HTTP methods for one RPC by using
|
|
2473
|
-
# the `additional_bindings` option. Example:
|
|
2474
|
-
# service Messaging `
|
|
2475
|
-
# rpc GetMessage(GetMessageRequest) returns (Message) `
|
|
2476
|
-
# option (google.api.http) = `
|
|
2477
|
-
# get: "/v1/messages/`message_id`"
|
|
2478
|
-
# additional_bindings `
|
|
2479
|
-
# get: "/v1/users/`user_id`/messages/`message_id`"
|
|
2480
|
-
# `
|
|
2481
|
-
# `;
|
|
2482
|
-
# `
|
|
2483
|
-
# `
|
|
2484
|
-
# message GetMessageRequest `
|
|
2485
|
-
# string message_id = 1;
|
|
2486
|
-
# string user_id = 2;
|
|
2487
|
-
# `
|
|
2488
|
-
# This enables the following two alternative HTTP JSON to RPC mappings:
|
|
2489
|
-
# HTTP | gRPC
|
|
2490
|
-
# -----|-----
|
|
2491
|
-
# `GET /v1/messages/123456` | `GetMessage(message_id: "123456")`
|
|
2492
|
-
# `GET /v1/users/me/messages/123456` | `GetMessage(user_id: "me" message_id:
|
|
2493
|
-
# "123456")`
|
|
2494
|
-
# ## Rules for HTTP mapping
|
|
2495
|
-
# 1. Leaf request fields (recursive expansion nested messages in the request
|
|
2496
|
-
# message) are classified into three categories:
|
|
2497
|
-
# - Fields referred by the path template. They are passed via the URL path.
|
|
2498
|
-
# - Fields referred by the HttpRule.body. They are passed via the HTTP
|
|
2499
|
-
# request body.
|
|
2500
|
-
# - All other fields are passed via the URL query parameters, and the
|
|
2501
|
-
# parameter name is the field path in the request message. A repeated
|
|
2502
|
-
# field can be represented as multiple query parameters under the same
|
|
2503
|
-
# name.
|
|
2504
|
-
# 2. If HttpRule.body is "*", there is no URL query parameter, all fields
|
|
2505
|
-
# are passed via URL path and HTTP request body.
|
|
2506
|
-
# 3. If HttpRule.body is omitted, there is no HTTP request body, all
|
|
2507
|
-
# fields are passed via URL path and URL query parameters.
|
|
2508
|
-
# ### Path template syntax
|
|
2509
|
-
# Template = "/" Segments [ Verb ] ;
|
|
2510
|
-
# Segments = Segment ` "/" Segment ` ;
|
|
2511
|
-
# Segment = "*" | "**" | LITERAL | Variable ;
|
|
2512
|
-
# Variable = "`" FieldPath [ "=" Segments ] "`" ;
|
|
2513
|
-
# FieldPath = IDENT ` "." IDENT ` ;
|
|
2514
|
-
# Verb = ":" LITERAL ;
|
|
2515
|
-
# The syntax `*` matches a single URL path segment. The syntax `**` matches
|
|
2516
|
-
# zero or more URL path segments, which must be the last part of the URL path
|
|
2517
|
-
# except the `Verb`.
|
|
2518
|
-
# The syntax `Variable` matches part of the URL path as specified by its
|
|
2519
|
-
# template. A variable template must not contain other variables. If a variable
|
|
2520
|
-
# matches a single path segment, its template may be omitted, e.g. ``var``
|
|
2521
|
-
# is equivalent to ``var=*``.
|
|
2522
|
-
# The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL`
|
|
2523
|
-
# contains any reserved character, such characters should be percent-encoded
|
|
2524
|
-
# before the matching.
|
|
2525
|
-
# If a variable contains exactly one path segment, such as `"`var`"` or
|
|
2526
|
-
# `"`var=*`"`, when such a variable is expanded into a URL path on the client
|
|
2527
|
-
# side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The
|
|
2528
|
-
# server side does the reverse decoding. Such variables show up in the
|
|
2529
|
-
# [Discovery
|
|
2530
|
-
# Document](https://developers.google.com/discovery/v1/reference/apis) as
|
|
2531
|
-
# ``var``.
|
|
2532
|
-
# If a variable contains multiple path segments, such as `"`var=foo/*`"`
|
|
2533
|
-
# or `"`var=**`"`, when such a variable is expanded into a URL path on the
|
|
2534
|
-
# client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded.
|
|
2535
|
-
# The server side does the reverse decoding, except "%2F" and "%2f" are left
|
|
2536
|
-
# unchanged. Such variables show up in the
|
|
2537
|
-
# [Discovery
|
|
2538
|
-
# Document](https://developers.google.com/discovery/v1/reference/apis) as
|
|
2539
|
-
# ``+var``.
|
|
2540
|
-
# ## Using gRPC API Service Configuration
|
|
2541
|
-
# gRPC API Service Configuration (service config) is a configuration language
|
|
2542
|
-
# for configuring a gRPC service to become a user-facing product. The
|
|
2543
|
-
# service config is simply the YAML representation of the `google.api.Service`
|
|
2544
|
-
# proto message.
|
|
2006
|
+
# as each field is a non-repeated field with a primitive (non-message) type. The
|
|
2007
|
+
# path template controls how fields of the request message are mapped to the URL
|
|
2008
|
+
# path. Example: service Messaging ` rpc GetMessage(GetMessageRequest) returns (
|
|
2009
|
+
# Message) ` option (google.api.http) = ` get: "/v1/`name=messages/*`" `; ` `
|
|
2010
|
+
# message GetMessageRequest ` string name = 1; // Mapped to URL path. ` message
|
|
2011
|
+
# Message ` string text = 1; // The resource content. ` This enables an HTTP
|
|
2012
|
+
# REST to gRPC mapping as below: HTTP | gRPC -----|----- `GET /v1/messages/
|
|
2013
|
+
# 123456` | `GetMessage(name: "messages/123456")` Any fields in the request
|
|
2014
|
+
# message which are not bound by the path template automatically become HTTP
|
|
2015
|
+
# query parameters if there is no HTTP request body. For example: service
|
|
2016
|
+
# Messaging ` rpc GetMessage(GetMessageRequest) returns (Message) ` option (
|
|
2017
|
+
# google.api.http) = ` get:"/v1/messages/`message_id`" `; ` ` message
|
|
2018
|
+
# GetMessageRequest ` message SubMessage ` string subfield = 1; ` string
|
|
2019
|
+
# message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL
|
|
2020
|
+
# query parameter `revision`. SubMessage sub = 3; // Mapped to URL query
|
|
2021
|
+
# parameter `sub.subfield`. ` This enables a HTTP JSON to RPC mapping as below:
|
|
2022
|
+
# HTTP | gRPC -----|----- `GET /v1/messages/123456?revision=2&sub.subfield=foo` |
|
|
2023
|
+
# `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: "foo"))
|
|
2024
|
+
# ` Note that fields which are mapped to URL query parameters must have a
|
|
2025
|
+
# primitive type or a repeated primitive type or a non-repeated message type. In
|
|
2026
|
+
# the case of a repeated type, the parameter can be repeated in the URL as `...?
|
|
2027
|
+
# param=A¶m=B`. In the case of a message type, each field of the message is
|
|
2028
|
+
# mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For
|
|
2029
|
+
# HTTP methods that allow a request body, the `body` field specifies the mapping.
|
|
2030
|
+
# Consider a REST update method on the message resource collection: service
|
|
2031
|
+
# Messaging ` rpc UpdateMessage(UpdateMessageRequest) returns (Message) ` option
|
|
2032
|
+
# (google.api.http) = ` patch: "/v1/messages/`message_id`" body: "message" `; ` `
|
|
2033
|
+
# message UpdateMessageRequest ` string message_id = 1; // mapped to the URL
|
|
2034
|
+
# Message message = 2; // mapped to the body ` The following HTTP JSON to RPC
|
|
2035
|
+
# mapping is enabled, where the representation of the JSON in the request body
|
|
2036
|
+
# is determined by protos JSON encoding: HTTP | gRPC -----|----- `PATCH /v1/
|
|
2037
|
+
# messages/123456 ` "text": "Hi!" `` | `UpdateMessage(message_id: "123456"
|
|
2038
|
+
# message ` text: "Hi!" `)` The special name `*` can be used in the body mapping
|
|
2039
|
+
# to define that every field not bound by the path template should be mapped to
|
|
2040
|
+
# the request body. This enables the following alternative definition of the
|
|
2041
|
+
# update method: service Messaging ` rpc UpdateMessage(Message) returns (Message)
|
|
2042
|
+
# ` option (google.api.http) = ` patch: "/v1/messages/`message_id`" body: "*" `;
|
|
2043
|
+
# ` ` message Message ` string message_id = 1; string text = 2; ` The following
|
|
2044
|
+
# HTTP JSON to RPC mapping is enabled: HTTP | gRPC -----|----- `PATCH /v1/
|
|
2045
|
+
# messages/123456 ` "text": "Hi!" `` | `UpdateMessage(message_id: "123456" text:
|
|
2046
|
+
# "Hi!")` Note that when using `*` in the body mapping, it is not possible to
|
|
2047
|
+
# have HTTP parameters, as all fields not bound by the path end in the body.
|
|
2048
|
+
# This makes this option more rarely used in practice when defining REST APIs.
|
|
2049
|
+
# The common usage of `*` is in custom methods which don't use the URL at all
|
|
2050
|
+
# for transferring data. It is possible to define multiple HTTP methods for one
|
|
2051
|
+
# RPC by using the `additional_bindings` option. Example: service Messaging `
|
|
2052
|
+
# rpc GetMessage(GetMessageRequest) returns (Message) ` option (google.api.http)
|
|
2053
|
+
# = ` get: "/v1/messages/`message_id`" additional_bindings ` get: "/v1/users/`
|
|
2054
|
+
# user_id`/messages/`message_id`" ` `; ` ` message GetMessageRequest ` string
|
|
2055
|
+
# message_id = 1; string user_id = 2; ` This enables the following two
|
|
2056
|
+
# alternative HTTP JSON to RPC mappings: HTTP | gRPC -----|----- `GET /v1/
|
|
2057
|
+
# messages/123456` | `GetMessage(message_id: "123456")` `GET /v1/users/me/
|
|
2058
|
+
# messages/123456` | `GetMessage(user_id: "me" message_id: "123456")` ## Rules
|
|
2059
|
+
# for HTTP mapping 1. Leaf request fields (recursive expansion nested messages
|
|
2060
|
+
# in the request message) are classified into three categories: - Fields
|
|
2061
|
+
# referred by the path template. They are passed via the URL path. - Fields
|
|
2062
|
+
# referred by the HttpRule.body. They are passed via the HTTP request body. -
|
|
2063
|
+
# All other fields are passed via the URL query parameters, and the parameter
|
|
2064
|
+
# name is the field path in the request message. A repeated field can be
|
|
2065
|
+
# represented as multiple query parameters under the same name. 2. If HttpRule.
|
|
2066
|
+
# body is "*", there is no URL query parameter, all fields are passed via URL
|
|
2067
|
+
# path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP
|
|
2068
|
+
# request body, all fields are passed via URL path and URL query parameters. ###
|
|
2069
|
+
# Path template syntax Template = "/" Segments [ Verb ] ; Segments = Segment ` "/
|
|
2070
|
+
# " Segment ` ; Segment = "*" | "**" | LITERAL | Variable ; Variable = "`"
|
|
2071
|
+
# FieldPath [ "=" Segments ] "`" ; FieldPath = IDENT ` "." IDENT ` ; Verb = ":"
|
|
2072
|
+
# LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**`
|
|
2073
|
+
# matches zero or more URL path segments, which must be the last part of the URL
|
|
2074
|
+
# path except the `Verb`. The syntax `Variable` matches part of the URL path as
|
|
2075
|
+
# specified by its template. A variable template must not contain other
|
|
2076
|
+
# variables. If a variable matches a single path segment, its template may be
|
|
2077
|
+
# omitted, e.g. ``var`` is equivalent to ``var=*``. The syntax `LITERAL` matches
|
|
2078
|
+
# literal text in the URL path. If the `LITERAL` contains any reserved character,
|
|
2079
|
+
# such characters should be percent-encoded before the matching. If a variable
|
|
2080
|
+
# contains exactly one path segment, such as `"`var`"` or `"`var=*`"`, when such
|
|
2081
|
+
# a variable is expanded into a URL path on the client side, all characters
|
|
2082
|
+
# except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse
|
|
2083
|
+
# decoding. Such variables show up in the [Discovery Document](https://
|
|
2084
|
+
# developers.google.com/discovery/v1/reference/apis) as ``var``. If a variable
|
|
2085
|
+
# contains multiple path segments, such as `"`var=foo/*`"` or `"`var=**`"`, when
|
|
2086
|
+
# such a variable is expanded into a URL path on the client side, all characters
|
|
2087
|
+
# except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the
|
|
2088
|
+
# reverse decoding, except "%2F" and "%2f" are left unchanged. Such variables
|
|
2089
|
+
# show up in the [Discovery Document](https://developers.google.com/discovery/v1/
|
|
2090
|
+
# reference/apis) as ``+var``. ## Using gRPC API Service Configuration gRPC API
|
|
2091
|
+
# Service Configuration (service config) is a configuration language for
|
|
2092
|
+
# configuring a gRPC service to become a user-facing product. The service config
|
|
2093
|
+
# is simply the YAML representation of the `google.api.Service` proto message.
|
|
2545
2094
|
# As an alternative to annotating your proto file, you can configure gRPC
|
|
2546
|
-
# transcoding in your service config YAML files. You do this by specifying a
|
|
2547
|
-
#
|
|
2548
|
-
# effect as the proto annotation. This can be particularly useful if you
|
|
2549
|
-
#
|
|
2550
|
-
#
|
|
2551
|
-
#
|
|
2552
|
-
#
|
|
2553
|
-
#
|
|
2554
|
-
#
|
|
2555
|
-
#
|
|
2556
|
-
#
|
|
2557
|
-
#
|
|
2558
|
-
#
|
|
2559
|
-
#
|
|
2560
|
-
#
|
|
2561
|
-
#
|
|
2562
|
-
# .
|
|
2563
|
-
#
|
|
2564
|
-
#
|
|
2565
|
-
#
|
|
2566
|
-
#
|
|
2567
|
-
#
|
|
2568
|
-
#
|
|
2569
|
-
# for
|
|
2570
|
-
#
|
|
2571
|
-
#
|
|
2572
|
-
# The path variables **must not** capture the leading "/" character. The reason
|
|
2573
|
-
# is that the most common use case "`var`" does not capture the leading "/"
|
|
2574
|
-
# character. For consistency, all path variables must share the same behavior.
|
|
2575
|
-
# Repeated message fields must not be mapped to URL query parameters, because
|
|
2576
|
-
# no client library can support such complicated mapping.
|
|
2577
|
-
# If an API needs to use a JSON array for request or response body, it can map
|
|
2578
|
-
# the request or response body to a repeated field. However, some gRPC
|
|
2579
|
-
# Transcoding implementations may not support this feature.
|
|
2095
|
+
# transcoding in your service config YAML files. You do this by specifying a `
|
|
2096
|
+
# HttpRule` that maps the gRPC method to a REST endpoint, achieving the same
|
|
2097
|
+
# effect as the proto annotation. This can be particularly useful if you have a
|
|
2098
|
+
# proto that is reused in multiple services. Note that any transcoding specified
|
|
2099
|
+
# in the service config will override any matching transcoding configuration in
|
|
2100
|
+
# the proto. Example: http: rules: # Selects a gRPC method and applies HttpRule
|
|
2101
|
+
# to it. - selector: example.v1.Messaging.GetMessage get: /v1/messages/`
|
|
2102
|
+
# message_id`/`sub.subfield` ## Special notes When gRPC Transcoding is used to
|
|
2103
|
+
# map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow
|
|
2104
|
+
# the [proto3 specification](https://developers.google.com/protocol-buffers/docs/
|
|
2105
|
+
# proto3#json). While the single segment variable follows the semantics of [RFC
|
|
2106
|
+
# 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String
|
|
2107
|
+
# Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.
|
|
2108
|
+
# 3 Reserved Expansion. The reason is that the Reserved Expansion does not
|
|
2109
|
+
# expand special characters like `?` and `#`, which would lead to invalid URLs.
|
|
2110
|
+
# As the result, gRPC Transcoding uses a custom encoding for multi segment
|
|
2111
|
+
# variables. The path variables **must not** refer to any repeated or mapped
|
|
2112
|
+
# field, because client libraries are not capable of handling such variable
|
|
2113
|
+
# expansion. The path variables **must not** capture the leading "/" character.
|
|
2114
|
+
# The reason is that the most common use case "`var`" does not capture the
|
|
2115
|
+
# leading "/" character. For consistency, all path variables must share the same
|
|
2116
|
+
# behavior. Repeated message fields must not be mapped to URL query parameters,
|
|
2117
|
+
# because no client library can support such complicated mapping. If an API
|
|
2118
|
+
# needs to use a JSON array for request or response body, it can map the request
|
|
2119
|
+
# or response body to a repeated field. However, some gRPC Transcoding
|
|
2120
|
+
# implementations may not support this feature.
|
|
2580
2121
|
class HttpRule
|
|
2581
2122
|
include Google::Apis::Core::Hashable
|
|
2582
2123
|
|
|
2583
|
-
# Additional HTTP bindings for the selector. Nested bindings must
|
|
2584
|
-
#
|
|
2585
|
-
#
|
|
2124
|
+
# Additional HTTP bindings for the selector. Nested bindings must not contain an
|
|
2125
|
+
# `additional_bindings` field themselves (that is, the nesting may only be one
|
|
2126
|
+
# level deep).
|
|
2586
2127
|
# Corresponds to the JSON property `additionalBindings`
|
|
2587
2128
|
# @return [Array<Google::Apis::ServiceusageV1beta1::HttpRule>]
|
|
2588
2129
|
attr_accessor :additional_bindings
|
|
2589
2130
|
|
|
2590
|
-
# When this flag is set to true, HTTP requests will be allowed to invoke a
|
|
2591
|
-
#
|
|
2131
|
+
# When this flag is set to true, HTTP requests will be allowed to invoke a half-
|
|
2132
|
+
# duplex streaming method.
|
|
2592
2133
|
# Corresponds to the JSON property `allowHalfDuplex`
|
|
2593
2134
|
# @return [Boolean]
|
|
2594
2135
|
attr_accessor :allow_half_duplex
|
|
2595
2136
|
alias_method :allow_half_duplex?, :allow_half_duplex
|
|
2596
2137
|
|
|
2597
|
-
# The name of the request field whose value is mapped to the HTTP request
|
|
2598
|
-
#
|
|
2599
|
-
#
|
|
2600
|
-
#
|
|
2601
|
-
# message type.
|
|
2138
|
+
# The name of the request field whose value is mapped to the HTTP request body,
|
|
2139
|
+
# or `*` for mapping all request fields not captured by the path pattern to the
|
|
2140
|
+
# HTTP body, or omitted for not having any HTTP request body. NOTE: the referred
|
|
2141
|
+
# field must be present at the top-level of the request message type.
|
|
2602
2142
|
# Corresponds to the JSON property `body`
|
|
2603
2143
|
# @return [String]
|
|
2604
2144
|
attr_accessor :body
|
|
@@ -2613,8 +2153,7 @@ module Google
|
|
|
2613
2153
|
# @return [String]
|
|
2614
2154
|
attr_accessor :delete
|
|
2615
2155
|
|
|
2616
|
-
# Maps to HTTP GET. Used for listing and getting information about
|
|
2617
|
-
# resources.
|
|
2156
|
+
# Maps to HTTP GET. Used for listing and getting information about resources.
|
|
2618
2157
|
# Corresponds to the JSON property `get`
|
|
2619
2158
|
# @return [String]
|
|
2620
2159
|
attr_accessor :get
|
|
@@ -2635,16 +2174,15 @@ module Google
|
|
|
2635
2174
|
attr_accessor :put
|
|
2636
2175
|
|
|
2637
2176
|
# Optional. The name of the response field whose value is mapped to the HTTP
|
|
2638
|
-
# response body. When omitted, the entire response message will be used
|
|
2639
|
-
#
|
|
2640
|
-
#
|
|
2641
|
-
# message type.
|
|
2177
|
+
# response body. When omitted, the entire response message will be used as the
|
|
2178
|
+
# HTTP response body. NOTE: The referred field must be present at the top-level
|
|
2179
|
+
# of the response message type.
|
|
2642
2180
|
# Corresponds to the JSON property `responseBody`
|
|
2643
2181
|
# @return [String]
|
|
2644
2182
|
attr_accessor :response_body
|
|
2645
2183
|
|
|
2646
|
-
# Selects a method to which this rule applies.
|
|
2647
|
-
#
|
|
2184
|
+
# Selects a method to which this rule applies. Refer to selector for syntax
|
|
2185
|
+
# details.
|
|
2648
2186
|
# Corresponds to the JSON property `selector`
|
|
2649
2187
|
# @return [String]
|
|
2650
2188
|
attr_accessor :selector
|
|
@@ -2711,11 +2249,11 @@ module Google
|
|
|
2711
2249
|
class ImportConsumerOverridesRequest
|
|
2712
2250
|
include Google::Apis::Core::Hashable
|
|
2713
2251
|
|
|
2714
|
-
# Whether to force the creation of the quota overrides.
|
|
2715
|
-
#
|
|
2716
|
-
#
|
|
2717
|
-
#
|
|
2718
|
-
#
|
|
2252
|
+
# Whether to force the creation of the quota overrides. If creating an override
|
|
2253
|
+
# would cause the effective quota for the consumer to decrease by more than 10
|
|
2254
|
+
# percent, the call is rejected, as a safety measure to avoid accidentally
|
|
2255
|
+
# decreasing quota too quickly. Setting the force parameter to true ignores this
|
|
2256
|
+
# restriction.
|
|
2719
2257
|
# Corresponds to the JSON property `force`
|
|
2720
2258
|
# @return [Boolean]
|
|
2721
2259
|
attr_accessor :force
|
|
@@ -2770,13 +2308,12 @@ module Google
|
|
|
2770
2308
|
# @return [String]
|
|
2771
2309
|
attr_accessor :query
|
|
2772
2310
|
|
|
2773
|
-
# The value prefix. The value format is "value_prefix`token`"
|
|
2774
|
-
#
|
|
2775
|
-
#
|
|
2776
|
-
# If
|
|
2777
|
-
#
|
|
2778
|
-
#
|
|
2779
|
-
# value_prefix="Bearer " with a space at the end.
|
|
2311
|
+
# The value prefix. The value format is "value_prefix`token`" Only applies to "
|
|
2312
|
+
# in" header type. Must be empty for "in" query type. If not empty, the header
|
|
2313
|
+
# value has to match (case sensitive) this prefix. If not matched, JWT will not
|
|
2314
|
+
# be extracted. If matched, JWT will be extracted after the prefix is removed.
|
|
2315
|
+
# For example, for "Authorization: Bearer `JWT`", value_prefix="Bearer " with a
|
|
2316
|
+
# space at the end.
|
|
2780
2317
|
# Corresponds to the JSON property `valuePrefix`
|
|
2781
2318
|
# @return [String]
|
|
2782
2319
|
attr_accessor :value_prefix
|
|
@@ -2828,8 +2365,7 @@ module Google
|
|
|
2828
2365
|
class ListAdminOverridesResponse
|
|
2829
2366
|
include Google::Apis::Core::Hashable
|
|
2830
2367
|
|
|
2831
|
-
# Token identifying which result to start with; returned by a previous list
|
|
2832
|
-
# call.
|
|
2368
|
+
# Token identifying which result to start with; returned by a previous list call.
|
|
2833
2369
|
# Corresponds to the JSON property `nextPageToken`
|
|
2834
2370
|
# @return [String]
|
|
2835
2371
|
attr_accessor :next_page_token
|
|
@@ -2854,8 +2390,7 @@ module Google
|
|
|
2854
2390
|
class ListConsumerOverridesResponse
|
|
2855
2391
|
include Google::Apis::Core::Hashable
|
|
2856
2392
|
|
|
2857
|
-
# Token identifying which result to start with; returned by a previous list
|
|
2858
|
-
# call.
|
|
2393
|
+
# Token identifying which result to start with; returned by a previous list call.
|
|
2859
2394
|
# Corresponds to the JSON property `nextPageToken`
|
|
2860
2395
|
# @return [String]
|
|
2861
2396
|
attr_accessor :next_page_token
|
|
@@ -2885,8 +2420,7 @@ module Google
|
|
|
2885
2420
|
# @return [Array<Google::Apis::ServiceusageV1beta1::ConsumerQuotaMetric>]
|
|
2886
2421
|
attr_accessor :metrics
|
|
2887
2422
|
|
|
2888
|
-
# Token identifying which result to start with; returned by a previous list
|
|
2889
|
-
# call.
|
|
2423
|
+
# Token identifying which result to start with; returned by a previous list call.
|
|
2890
2424
|
# Corresponds to the JSON property `nextPageToken`
|
|
2891
2425
|
# @return [String]
|
|
2892
2426
|
attr_accessor :next_page_token
|
|
@@ -2931,8 +2465,7 @@ module Google
|
|
|
2931
2465
|
class ListServicesResponse
|
|
2932
2466
|
include Google::Apis::Core::Hashable
|
|
2933
2467
|
|
|
2934
|
-
# Token that can be passed to `ListServices` to resume a paginated
|
|
2935
|
-
# query.
|
|
2468
|
+
# Token that can be passed to `ListServices` to resume a paginated query.
|
|
2936
2469
|
# Corresponds to the JSON property `nextPageToken`
|
|
2937
2470
|
# @return [String]
|
|
2938
2471
|
attr_accessor :next_page_token
|
|
@@ -2953,39 +2486,35 @@ module Google
|
|
|
2953
2486
|
end
|
|
2954
2487
|
end
|
|
2955
2488
|
|
|
2956
|
-
# A description of a log type. Example in YAML format:
|
|
2957
|
-
#
|
|
2958
|
-
#
|
|
2959
|
-
# display_name: Activity
|
|
2960
|
-
# labels:
|
|
2961
|
-
# - key: /customer_id
|
|
2489
|
+
# A description of a log type. Example in YAML format: - name: library.
|
|
2490
|
+
# googleapis.com/activity_history description: The history of borrowing and
|
|
2491
|
+
# returning library items. display_name: Activity labels: - key: /customer_id
|
|
2962
2492
|
# description: Identifier of a library customer
|
|
2963
2493
|
class LogDescriptor
|
|
2964
2494
|
include Google::Apis::Core::Hashable
|
|
2965
2495
|
|
|
2966
|
-
# A human-readable description of this log. This information appears in
|
|
2967
|
-
#
|
|
2496
|
+
# A human-readable description of this log. This information appears in the
|
|
2497
|
+
# documentation and can contain details.
|
|
2968
2498
|
# Corresponds to the JSON property `description`
|
|
2969
2499
|
# @return [String]
|
|
2970
2500
|
attr_accessor :description
|
|
2971
2501
|
|
|
2972
|
-
# The human-readable name for this log. This information appears on
|
|
2973
|
-
#
|
|
2502
|
+
# The human-readable name for this log. This information appears on the user
|
|
2503
|
+
# interface and should be concise.
|
|
2974
2504
|
# Corresponds to the JSON property `displayName`
|
|
2975
2505
|
# @return [String]
|
|
2976
2506
|
attr_accessor :display_name
|
|
2977
2507
|
|
|
2978
|
-
# The set of labels that are available to describe a specific log entry.
|
|
2979
|
-
#
|
|
2980
|
-
# considered invalid.
|
|
2508
|
+
# The set of labels that are available to describe a specific log entry. Runtime
|
|
2509
|
+
# requests that contain labels not specified here are considered invalid.
|
|
2981
2510
|
# Corresponds to the JSON property `labels`
|
|
2982
2511
|
# @return [Array<Google::Apis::ServiceusageV1beta1::LabelDescriptor>]
|
|
2983
2512
|
attr_accessor :labels
|
|
2984
2513
|
|
|
2985
|
-
# The name of the log. It must be less than 512 characters long and can
|
|
2986
|
-
#
|
|
2987
|
-
#
|
|
2988
|
-
#
|
|
2514
|
+
# The name of the log. It must be less than 512 characters long and can include
|
|
2515
|
+
# the following characters: upper- and lower-case alphanumeric characters [A-Za-
|
|
2516
|
+
# z0-9], and punctuation characters including slash, underscore, hyphen, period [
|
|
2517
|
+
# /_-.].
|
|
2989
2518
|
# Corresponds to the JSON property `name`
|
|
2990
2519
|
# @return [String]
|
|
2991
2520
|
attr_accessor :name
|
|
@@ -3003,48 +2532,30 @@ module Google
|
|
|
3003
2532
|
end
|
|
3004
2533
|
end
|
|
3005
2534
|
|
|
3006
|
-
# Logging configuration of the service.
|
|
3007
|
-
#
|
|
3008
|
-
#
|
|
3009
|
-
# log is sent to
|
|
3010
|
-
#
|
|
3011
|
-
#
|
|
3012
|
-
# -
|
|
3013
|
-
# labels:
|
|
3014
|
-
# -
|
|
3015
|
-
#
|
|
3016
|
-
#
|
|
3017
|
-
# description: The name of the branch.
|
|
3018
|
-
# logs:
|
|
3019
|
-
# - name: activity_history
|
|
3020
|
-
# labels:
|
|
3021
|
-
# - key: /customer_id
|
|
3022
|
-
# - name: purchase_history
|
|
3023
|
-
# logging:
|
|
3024
|
-
# producer_destinations:
|
|
3025
|
-
# - monitored_resource: library.googleapis.com/branch
|
|
3026
|
-
# logs:
|
|
3027
|
-
# - activity_history
|
|
3028
|
-
# - purchase_history
|
|
3029
|
-
# consumer_destinations:
|
|
3030
|
-
# - monitored_resource: library.googleapis.com/branch
|
|
3031
|
-
# logs:
|
|
3032
|
-
# - activity_history
|
|
2535
|
+
# Logging configuration of the service. The following example shows how to
|
|
2536
|
+
# configure logs to be sent to the producer and consumer projects. In the
|
|
2537
|
+
# example, the `activity_history` log is sent to both the producer and consumer
|
|
2538
|
+
# projects, whereas the `purchase_history` log is only sent to the producer
|
|
2539
|
+
# project. monitored_resources: - type: library.googleapis.com/branch labels: -
|
|
2540
|
+
# key: /city description: The city where the library branch is located in. - key:
|
|
2541
|
+
# /name description: The name of the branch. logs: - name: activity_history
|
|
2542
|
+
# labels: - key: /customer_id - name: purchase_history logging:
|
|
2543
|
+
# producer_destinations: - monitored_resource: library.googleapis.com/branch
|
|
2544
|
+
# logs: - activity_history - purchase_history consumer_destinations: -
|
|
2545
|
+
# monitored_resource: library.googleapis.com/branch logs: - activity_history
|
|
3033
2546
|
class Logging
|
|
3034
2547
|
include Google::Apis::Core::Hashable
|
|
3035
2548
|
|
|
3036
|
-
# Logging configurations for sending logs to the consumer project.
|
|
3037
|
-
#
|
|
3038
|
-
#
|
|
3039
|
-
# one consumer destination.
|
|
2549
|
+
# Logging configurations for sending logs to the consumer project. There can be
|
|
2550
|
+
# multiple consumer destinations, each one must have a different monitored
|
|
2551
|
+
# resource type. A log can be used in at most one consumer destination.
|
|
3040
2552
|
# Corresponds to the JSON property `consumerDestinations`
|
|
3041
2553
|
# @return [Array<Google::Apis::ServiceusageV1beta1::LoggingDestination>]
|
|
3042
2554
|
attr_accessor :consumer_destinations
|
|
3043
2555
|
|
|
3044
|
-
# Logging configurations for sending logs to the producer project.
|
|
3045
|
-
#
|
|
3046
|
-
#
|
|
3047
|
-
# one producer destination.
|
|
2556
|
+
# Logging configurations for sending logs to the producer project. There can be
|
|
2557
|
+
# multiple producer destinations, each one must have a different monitored
|
|
2558
|
+
# resource type. A log can be used in at most one producer destination.
|
|
3048
2559
|
# Corresponds to the JSON property `producerDestinations`
|
|
3049
2560
|
# @return [Array<Google::Apis::ServiceusageV1beta1::LoggingDestination>]
|
|
3050
2561
|
attr_accessor :producer_destinations
|
|
@@ -3060,21 +2571,20 @@ module Google
|
|
|
3060
2571
|
end
|
|
3061
2572
|
end
|
|
3062
2573
|
|
|
3063
|
-
# Configuration of a specific logging destination (the producer project
|
|
3064
|
-
#
|
|
2574
|
+
# Configuration of a specific logging destination (the producer project or the
|
|
2575
|
+
# consumer project).
|
|
3065
2576
|
class LoggingDestination
|
|
3066
2577
|
include Google::Apis::Core::Hashable
|
|
3067
2578
|
|
|
3068
|
-
# Names of the logs to be sent to this destination. Each name must
|
|
3069
|
-
#
|
|
3070
|
-
#
|
|
3071
|
-
# the service name followed by "/".
|
|
2579
|
+
# Names of the logs to be sent to this destination. Each name must be defined in
|
|
2580
|
+
# the Service.logs section. If the log name is not a domain scoped name, it will
|
|
2581
|
+
# be automatically prefixed with the service name followed by "/".
|
|
3072
2582
|
# Corresponds to the JSON property `logs`
|
|
3073
2583
|
# @return [Array<String>]
|
|
3074
2584
|
attr_accessor :logs
|
|
3075
2585
|
|
|
3076
|
-
# The monitored resource type. The type must be defined in the
|
|
3077
|
-
#
|
|
2586
|
+
# The monitored resource type. The type must be defined in the Service.
|
|
2587
|
+
# monitored_resources section.
|
|
3078
2588
|
# Corresponds to the JSON property `monitoredResource`
|
|
3079
2589
|
# @return [String]
|
|
3080
2590
|
attr_accessor :monitored_resource
|
|
@@ -3149,16 +2659,13 @@ module Google
|
|
|
3149
2659
|
|
|
3150
2660
|
# Defines a metric type and its schema. Once a metric descriptor is created,
|
|
3151
2661
|
# deleting or altering it stops data collection and makes the metric type's
|
|
3152
|
-
# existing data unusable.
|
|
3153
|
-
#
|
|
3154
|
-
#
|
|
3155
|
-
#
|
|
3156
|
-
#
|
|
3157
|
-
#
|
|
3158
|
-
#
|
|
3159
|
-
# * Maximum of default 10 labels per metric descriptor is allowed.
|
|
3160
|
-
# The default maximum limit can be overridden. Please follow
|
|
3161
|
-
# https://cloud.google.com/monitoring/quotas
|
|
2662
|
+
# existing data unusable. The following are specific rules for service defined
|
|
2663
|
+
# Monitoring metric descriptors: * `type`, `metric_kind`, `value_type` and `
|
|
2664
|
+
# description` fields are all required. The `unit` field must be specified if
|
|
2665
|
+
# the `value_type` is any of DOUBLE, INT64, DISTRIBUTION. * Maximum of default
|
|
2666
|
+
# 500 metric descriptors per service is allowed. * Maximum of default 10 labels
|
|
2667
|
+
# per metric descriptor is allowed. The default maximum limit can be overridden.
|
|
2668
|
+
# Please follow https://cloud.google.com/monitoring/quotas
|
|
3162
2669
|
class MetricDescriptor
|
|
3163
2670
|
include Google::Apis::Core::Hashable
|
|
3164
2671
|
|
|
@@ -3167,26 +2674,21 @@ module Google
|
|
|
3167
2674
|
# @return [String]
|
|
3168
2675
|
attr_accessor :description
|
|
3169
2676
|
|
|
3170
|
-
# A concise name for the metric, which can be displayed in user interfaces.
|
|
3171
|
-
#
|
|
3172
|
-
#
|
|
3173
|
-
#
|
|
2677
|
+
# A concise name for the metric, which can be displayed in user interfaces. Use
|
|
2678
|
+
# sentence case without an ending period, for example "Request count". This
|
|
2679
|
+
# field is optional but it is recommended to be set for any metrics associated
|
|
2680
|
+
# with user-visible concepts, such as Quota.
|
|
3174
2681
|
# Corresponds to the JSON property `displayName`
|
|
3175
2682
|
# @return [String]
|
|
3176
2683
|
attr_accessor :display_name
|
|
3177
2684
|
|
|
3178
|
-
# The set of labels that can be used to describe a specific
|
|
3179
|
-
#
|
|
3180
|
-
#
|
|
3181
|
-
# *
|
|
3182
|
-
#
|
|
3183
|
-
#
|
|
3184
|
-
#
|
|
3185
|
-
# For example, the
|
|
3186
|
-
# `appengine.googleapis.com/http/server/response_latencies` metric
|
|
3187
|
-
# type has a label for the HTTP response code, `response_code`, so
|
|
3188
|
-
# you can look at latencies for successful responses or just
|
|
3189
|
-
# for responses that failed.
|
|
2685
|
+
# The set of labels that can be used to describe a specific instance of this
|
|
2686
|
+
# metric type. The label key name must follow: * Only upper and lower-case
|
|
2687
|
+
# letters, digits and underscores (_) are allowed. * Label name must start with
|
|
2688
|
+
# a letter or digit. * The maximum length of a label name is 100 characters. For
|
|
2689
|
+
# example, the `appengine.googleapis.com/http/server/response_latencies` metric
|
|
2690
|
+
# type has a label for the HTTP response code, `response_code`, so you can look
|
|
2691
|
+
# at latencies for successful responses or just for responses that failed.
|
|
3190
2692
|
# Corresponds to the JSON property `labels`
|
|
3191
2693
|
# @return [Array<Google::Apis::ServiceusageV1beta1::LabelDescriptor>]
|
|
3192
2694
|
attr_accessor :labels
|
|
@@ -3201,17 +2703,16 @@ module Google
|
|
|
3201
2703
|
# @return [Google::Apis::ServiceusageV1beta1::MetricDescriptorMetadata]
|
|
3202
2704
|
attr_accessor :metadata
|
|
3203
2705
|
|
|
3204
|
-
# Whether the metric records instantaneous values, changes to a value, etc.
|
|
3205
|
-
#
|
|
2706
|
+
# Whether the metric records instantaneous values, changes to a value, etc. Some
|
|
2707
|
+
# combinations of `metric_kind` and `value_type` might not be supported.
|
|
3206
2708
|
# Corresponds to the JSON property `metricKind`
|
|
3207
2709
|
# @return [String]
|
|
3208
2710
|
attr_accessor :metric_kind
|
|
3209
2711
|
|
|
3210
|
-
# Read-only. If present, then a time
|
|
3211
|
-
#
|
|
3212
|
-
#
|
|
3213
|
-
#
|
|
3214
|
-
# resource types listed here.
|
|
2712
|
+
# Read-only. If present, then a time series, which is identified partially by a
|
|
2713
|
+
# metric type and a MonitoredResourceDescriptor, that is associated with this
|
|
2714
|
+
# metric type can only be associated with one of the monitored resource types
|
|
2715
|
+
# listed here.
|
|
3215
2716
|
# Corresponds to the JSON property `monitoredResourceTypes`
|
|
3216
2717
|
# @return [Array<String>]
|
|
3217
2718
|
attr_accessor :monitored_resource_types
|
|
@@ -3221,116 +2722,73 @@ module Google
|
|
|
3221
2722
|
# @return [String]
|
|
3222
2723
|
attr_accessor :name
|
|
3223
2724
|
|
|
3224
|
-
# The metric type, including its DNS name prefix. The type is not
|
|
3225
|
-
# URL-encoded.
|
|
2725
|
+
# The metric type, including its DNS name prefix. The type is not URL-encoded.
|
|
3226
2726
|
# All service defined metrics must be prefixed with the service name, in the
|
|
3227
|
-
# format of ``service name`/`relative metric name``, such as
|
|
3228
|
-
#
|
|
3229
|
-
# name must follow:
|
|
2727
|
+
# format of ``service name`/`relative metric name``, such as `cloudsql.
|
|
2728
|
+
# googleapis.com/database/cpu/utilization`. The relative metric name must follow:
|
|
3230
2729
|
# * Only upper and lower-case letters, digits, '/' and underscores '_' are
|
|
3231
|
-
# allowed.
|
|
3232
|
-
#
|
|
3233
|
-
#
|
|
3234
|
-
#
|
|
3235
|
-
#
|
|
3236
|
-
#
|
|
3237
|
-
# Metric types should use a natural hierarchical grouping. For example:
|
|
3238
|
-
# "custom.googleapis.com/invoice/paid/amount"
|
|
3239
|
-
# "external.googleapis.com/prometheus/up"
|
|
3240
|
-
# "appengine.googleapis.com/http/server/response_latencies"
|
|
2730
|
+
# allowed. * The maximum number of characters allowed for the
|
|
2731
|
+
# relative_metric_name is 100. All user-defined metric types have the DNS name `
|
|
2732
|
+
# custom.googleapis.com`, `external.googleapis.com`, or `logging.googleapis.com/
|
|
2733
|
+
# user/`. Metric types should use a natural hierarchical grouping. For example: "
|
|
2734
|
+
# custom.googleapis.com/invoice/paid/amount" "external.googleapis.com/prometheus/
|
|
2735
|
+
# up" "appengine.googleapis.com/http/server/response_latencies"
|
|
3241
2736
|
# Corresponds to the JSON property `type`
|
|
3242
2737
|
# @return [String]
|
|
3243
2738
|
attr_accessor :type
|
|
3244
2739
|
|
|
3245
|
-
# The units in which the metric value is reported. It is only applicable
|
|
3246
|
-
#
|
|
3247
|
-
#
|
|
3248
|
-
#
|
|
3249
|
-
# value of `
|
|
3250
|
-
#
|
|
3251
|
-
#
|
|
3252
|
-
#
|
|
3253
|
-
#
|
|
3254
|
-
#
|
|
3255
|
-
# `
|
|
3256
|
-
#
|
|
3257
|
-
#
|
|
3258
|
-
#
|
|
3259
|
-
#
|
|
3260
|
-
#
|
|
3261
|
-
#
|
|
3262
|
-
#
|
|
3263
|
-
#
|
|
3264
|
-
# * `
|
|
3265
|
-
# * `
|
|
3266
|
-
# * `
|
|
3267
|
-
# * `
|
|
3268
|
-
# * `
|
|
3269
|
-
#
|
|
3270
|
-
#
|
|
3271
|
-
#
|
|
3272
|
-
#
|
|
3273
|
-
#
|
|
3274
|
-
#
|
|
3275
|
-
# * `
|
|
3276
|
-
#
|
|
3277
|
-
# * `
|
|
3278
|
-
#
|
|
3279
|
-
# * `
|
|
3280
|
-
#
|
|
3281
|
-
#
|
|
3282
|
-
#
|
|
3283
|
-
#
|
|
3284
|
-
#
|
|
3285
|
-
# *
|
|
3286
|
-
#
|
|
3287
|
-
#
|
|
3288
|
-
# * `
|
|
3289
|
-
#
|
|
3290
|
-
#
|
|
3291
|
-
# * `Ti` tebi (2^40)
|
|
3292
|
-
# * `Pi` pebi (2^50)
|
|
3293
|
-
# **Grammar**
|
|
3294
|
-
# The grammar also includes these connectors:
|
|
3295
|
-
# * `/` division or ratio (as an infix operator). For examples,
|
|
3296
|
-
# `kBy/`email`` or `MiBy/10ms` (although you should almost never
|
|
3297
|
-
# have `/s` in a metric `unit`; rates should always be computed at
|
|
3298
|
-
# query time from the underlying cumulative or delta value).
|
|
3299
|
-
# * `.` multiplication or composition (as an infix operator). For
|
|
3300
|
-
# examples, `GBy.d` or `k`watt`.h`.
|
|
3301
|
-
# The grammar for a unit is as follows:
|
|
3302
|
-
# Expression = Component ` "." Component ` ` "/" Component ` ;
|
|
3303
|
-
# Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ]
|
|
3304
|
-
# | Annotation
|
|
3305
|
-
# | "1"
|
|
3306
|
-
# ;
|
|
3307
|
-
# Annotation = "`" NAME "`" ;
|
|
3308
|
-
# Notes:
|
|
3309
|
-
# * `Annotation` is just a comment if it follows a `UNIT`. If the annotation
|
|
3310
|
-
# is used alone, then the unit is equivalent to `1`. For examples,
|
|
3311
|
-
# ``request`/s == 1/s`, `By`transmitted`/s == By/s`.
|
|
3312
|
-
# * `NAME` is a sequence of non-blank printable ASCII characters not
|
|
3313
|
-
# containing ``` or ```.
|
|
3314
|
-
# * `1` represents a unitary [dimensionless
|
|
3315
|
-
# unit](https://en.wikipedia.org/wiki/Dimensionless_quantity) of 1, such
|
|
3316
|
-
# as in `1/s`. It is typically used when none of the basic units are
|
|
3317
|
-
# appropriate. For example, "new users per day" can be represented as
|
|
3318
|
-
# `1/d` or ``new-users`/d` (and a metric value `5` would mean "5 new
|
|
3319
|
-
# users). Alternatively, "thousands of page views per day" would be
|
|
3320
|
-
# represented as `1000/d` or `k1/d` or `k`page_views`/d` (and a metric
|
|
3321
|
-
# value of `5.3` would mean "5300 page views per day").
|
|
3322
|
-
# * `%` represents dimensionless value of 1/100, and annotates values giving
|
|
3323
|
-
# a percentage (so the metric values are typically in the range of 0..100,
|
|
3324
|
-
# and a metric value `3` means "3 percent").
|
|
3325
|
-
# * `10^2.%` indicates a metric contains a ratio, typically in the range
|
|
3326
|
-
# 0..1, that will be multiplied by 100 and displayed as a percentage
|
|
3327
|
-
# (so a metric value `0.03` means "3 percent").
|
|
2740
|
+
# The units in which the metric value is reported. It is only applicable if the `
|
|
2741
|
+
# value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The `unit` defines the
|
|
2742
|
+
# representation of the stored metric values. Different systems may scale the
|
|
2743
|
+
# values to be more easily displayed (so a value of `0.02KBy` _might_ be
|
|
2744
|
+
# displayed as `20By`, and a value of `3523KBy` _might_ be displayed as `3.5MBy`)
|
|
2745
|
+
# . However, if the `unit` is `KBy`, then the value of the metric is always in
|
|
2746
|
+
# thousands of bytes, no matter how it may be displayed.. If you want a custom
|
|
2747
|
+
# metric to record the exact number of CPU-seconds used by a job, you can create
|
|
2748
|
+
# an `INT64 CUMULATIVE` metric whose `unit` is `s`CPU`` (or equivalently `1s`CPU`
|
|
2749
|
+
# ` or just `s`). If the job uses 12,005 CPU-seconds, then the value is written
|
|
2750
|
+
# as `12005`. Alternatively, if you want a custom metric to record data in a
|
|
2751
|
+
# more granular way, you can create a `DOUBLE CUMULATIVE` metric whose `unit` is
|
|
2752
|
+
# `ks`CPU``, and then write the value `12.005` (which is `12005/1000`), or use `
|
|
2753
|
+
# Kis`CPU`` and write `11.723` (which is `12005/1024`). The supported units are
|
|
2754
|
+
# a subset of [The Unified Code for Units of Measure](http://unitsofmeasure.org/
|
|
2755
|
+
# ucum.html) standard: **Basic units (UNIT)** * `bit` bit * `By` byte * `s`
|
|
2756
|
+
# second * `min` minute * `h` hour * `d` day * `1` dimensionless **Prefixes (
|
|
2757
|
+
# PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga (10^9) * `T` tera (10^
|
|
2758
|
+
# 12) * `P` peta (10^15) * `E` exa (10^18) * `Z` zetta (10^21) * `Y` yotta (10^
|
|
2759
|
+
# 24) * `m` milli (10^-3) * `u` micro (10^-6) * `n` nano (10^-9) * `p` pico (10^-
|
|
2760
|
+
# 12) * `f` femto (10^-15) * `a` atto (10^-18) * `z` zepto (10^-21) * `y` yocto (
|
|
2761
|
+
# 10^-24) * `Ki` kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (
|
|
2762
|
+
# 2^40) * `Pi` pebi (2^50) **Grammar** The grammar also includes these
|
|
2763
|
+
# connectors: * `/` division or ratio (as an infix operator). For examples, `kBy/
|
|
2764
|
+
# `email`` or `MiBy/10ms` (although you should almost never have `/s` in a
|
|
2765
|
+
# metric `unit`; rates should always be computed at query time from the
|
|
2766
|
+
# underlying cumulative or delta value). * `.` multiplication or composition (as
|
|
2767
|
+
# an infix operator). For examples, `GBy.d` or `k`watt`.h`. The grammar for a
|
|
2768
|
+
# unit is as follows: Expression = Component ` "." Component ` ` "/" Component `
|
|
2769
|
+
# ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ;
|
|
2770
|
+
# Annotation = "`" NAME "`" ; Notes: * `Annotation` is just a comment if it
|
|
2771
|
+
# follows a `UNIT`. If the annotation is used alone, then the unit is equivalent
|
|
2772
|
+
# to `1`. For examples, ``request`/s == 1/s`, `By`transmitted`/s == By/s`. * `
|
|
2773
|
+
# NAME` is a sequence of non-blank printable ASCII characters not containing ```
|
|
2774
|
+
# or ```. * `1` represents a unitary [dimensionless unit](https://en.wikipedia.
|
|
2775
|
+
# org/wiki/Dimensionless_quantity) of 1, such as in `1/s`. It is typically used
|
|
2776
|
+
# when none of the basic units are appropriate. For example, "new users per day"
|
|
2777
|
+
# can be represented as `1/d` or ``new-users`/d` (and a metric value `5` would
|
|
2778
|
+
# mean "5 new users). Alternatively, "thousands of page views per day" would be
|
|
2779
|
+
# represented as `1000/d` or `k1/d` or `k`page_views`/d` (and a metric value of `
|
|
2780
|
+
# 5.3` would mean "5300 page views per day"). * `%` represents dimensionless
|
|
2781
|
+
# value of 1/100, and annotates values giving a percentage (so the metric values
|
|
2782
|
+
# are typically in the range of 0..100, and a metric value `3` means "3 percent")
|
|
2783
|
+
# . * `10^2.%` indicates a metric contains a ratio, typically in the range 0..1,
|
|
2784
|
+
# that will be multiplied by 100 and displayed as a percentage (so a metric
|
|
2785
|
+
# value `0.03` means "3 percent").
|
|
3328
2786
|
# Corresponds to the JSON property `unit`
|
|
3329
2787
|
# @return [String]
|
|
3330
2788
|
attr_accessor :unit
|
|
3331
2789
|
|
|
3332
|
-
# Whether the measurement is an integer, a floating-point number, etc.
|
|
3333
|
-
#
|
|
2790
|
+
# Whether the measurement is an integer, a floating-point number, etc. Some
|
|
2791
|
+
# combinations of `metric_kind` and `value_type` might not be supported.
|
|
3334
2792
|
# Corresponds to the JSON property `valueType`
|
|
3335
2793
|
# @return [String]
|
|
3336
2794
|
attr_accessor :value_type
|
|
@@ -3359,9 +2817,9 @@ module Google
|
|
|
3359
2817
|
class MetricDescriptorMetadata
|
|
3360
2818
|
include Google::Apis::Core::Hashable
|
|
3361
2819
|
|
|
3362
|
-
# The delay of data points caused by ingestion. Data points older than this
|
|
3363
|
-
#
|
|
3364
|
-
#
|
|
2820
|
+
# The delay of data points caused by ingestion. Data points older than this age
|
|
2821
|
+
# are guaranteed to be ingested and available to be read, excluding data loss
|
|
2822
|
+
# due to errors.
|
|
3365
2823
|
# Corresponds to the JSON property `ingestDelay`
|
|
3366
2824
|
# @return [String]
|
|
3367
2825
|
attr_accessor :ingest_delay
|
|
@@ -3373,8 +2831,8 @@ module Google
|
|
|
3373
2831
|
|
|
3374
2832
|
# The sampling period of metric data points. For metrics which are written
|
|
3375
2833
|
# periodically, consecutive data points are stored at this time interval,
|
|
3376
|
-
# excluding data loss due to errors. Metrics with a higher granularity have
|
|
3377
|
-
#
|
|
2834
|
+
# excluding data loss due to errors. Metrics with a higher granularity have a
|
|
2835
|
+
# smaller sampling period.
|
|
3378
2836
|
# Corresponds to the JSON property `samplePeriod`
|
|
3379
2837
|
# @return [String]
|
|
3380
2838
|
attr_accessor :sample_period
|
|
@@ -3391,22 +2849,21 @@ module Google
|
|
|
3391
2849
|
end
|
|
3392
2850
|
end
|
|
3393
2851
|
|
|
3394
|
-
# Bind API methods to metrics. Binding a method to a metric causes that
|
|
3395
|
-
#
|
|
2852
|
+
# Bind API methods to metrics. Binding a method to a metric causes that metric's
|
|
2853
|
+
# configured quota behaviors to apply to the method call.
|
|
3396
2854
|
class MetricRule
|
|
3397
2855
|
include Google::Apis::Core::Hashable
|
|
3398
2856
|
|
|
3399
2857
|
# Metrics to update when the selected methods are called, and the associated
|
|
3400
|
-
# cost applied to each metric.
|
|
3401
|
-
#
|
|
3402
|
-
#
|
|
3403
|
-
# The value must not be negative.
|
|
2858
|
+
# cost applied to each metric. The key of the map is the metric name, and the
|
|
2859
|
+
# values are the amount increased for the metric against which the quota limits
|
|
2860
|
+
# are defined. The value must not be negative.
|
|
3404
2861
|
# Corresponds to the JSON property `metricCosts`
|
|
3405
2862
|
# @return [Hash<String,Fixnum>]
|
|
3406
2863
|
attr_accessor :metric_costs
|
|
3407
2864
|
|
|
3408
|
-
# Selects the methods to which this rule applies.
|
|
3409
|
-
#
|
|
2865
|
+
# Selects the methods to which this rule applies. Refer to selector for syntax
|
|
2866
|
+
# details.
|
|
3410
2867
|
# Corresponds to the JSON property `selector`
|
|
3411
2868
|
# @return [String]
|
|
3412
2869
|
attr_accessor :selector
|
|
@@ -3424,66 +2881,33 @@ module Google
|
|
|
3424
2881
|
|
|
3425
2882
|
# Declares an API Interface to be included in this interface. The including
|
|
3426
2883
|
# interface must redeclare all the methods from the included interface, but
|
|
3427
|
-
# documentation and options are inherited as follows:
|
|
3428
|
-
#
|
|
3429
|
-
#
|
|
3430
|
-
#
|
|
3431
|
-
#
|
|
3432
|
-
#
|
|
3433
|
-
#
|
|
3434
|
-
#
|
|
3435
|
-
#
|
|
3436
|
-
#
|
|
3437
|
-
#
|
|
3438
|
-
#
|
|
3439
|
-
#
|
|
3440
|
-
#
|
|
3441
|
-
#
|
|
3442
|
-
#
|
|
3443
|
-
#
|
|
3444
|
-
# `
|
|
3445
|
-
# `
|
|
3446
|
-
#
|
|
3447
|
-
#
|
|
3448
|
-
#
|
|
3449
|
-
#
|
|
3450
|
-
#
|
|
3451
|
-
#
|
|
3452
|
-
# `
|
|
3453
|
-
# `
|
|
3454
|
-
# Example of a mixin configuration:
|
|
3455
|
-
# apis:
|
|
3456
|
-
# - name: google.storage.v2.Storage
|
|
3457
|
-
# mixins:
|
|
3458
|
-
# - name: google.acl.v1.AccessControl
|
|
3459
|
-
# The mixin construct implies that all methods in `AccessControl` are
|
|
3460
|
-
# also declared with same name and request/response types in
|
|
3461
|
-
# `Storage`. A documentation generator or annotation processor will
|
|
3462
|
-
# see the effective `Storage.GetAcl` method after inherting
|
|
3463
|
-
# documentation and annotations as follows:
|
|
3464
|
-
# service Storage `
|
|
3465
|
-
# // Get the underlying ACL object.
|
|
3466
|
-
# rpc GetAcl(GetAclRequest) returns (Acl) `
|
|
3467
|
-
# option (google.api.http).get = "/v2/`resource=**`:getAcl";
|
|
3468
|
-
# `
|
|
3469
|
-
# ...
|
|
3470
|
-
# `
|
|
3471
|
-
# Note how the version in the path pattern changed from `v1` to `v2`.
|
|
3472
|
-
# If the `root` field in the mixin is specified, it should be a
|
|
3473
|
-
# relative path under which inherited HTTP paths are placed. Example:
|
|
3474
|
-
# apis:
|
|
3475
|
-
# - name: google.storage.v2.Storage
|
|
3476
|
-
# mixins:
|
|
3477
|
-
# - name: google.acl.v1.AccessControl
|
|
3478
|
-
# root: acls
|
|
3479
|
-
# This implies the following inherited HTTP annotation:
|
|
3480
|
-
# service Storage `
|
|
3481
|
-
# // Get the underlying ACL object.
|
|
3482
|
-
# rpc GetAcl(GetAclRequest) returns (Acl) `
|
|
3483
|
-
# option (google.api.http).get = "/v2/acls/`resource=**`:getAcl";
|
|
3484
|
-
# `
|
|
3485
|
-
# ...
|
|
3486
|
-
# `
|
|
2884
|
+
# documentation and options are inherited as follows: - If after comment and
|
|
2885
|
+
# whitespace stripping, the documentation string of the redeclared method is
|
|
2886
|
+
# empty, it will be inherited from the original method. - Each annotation
|
|
2887
|
+
# belonging to the service config (http, visibility) which is not set in the
|
|
2888
|
+
# redeclared method will be inherited. - If an http annotation is inherited, the
|
|
2889
|
+
# path pattern will be modified as follows. Any version prefix will be replaced
|
|
2890
|
+
# by the version of the including interface plus the root path if specified.
|
|
2891
|
+
# Example of a simple mixin: package google.acl.v1; service AccessControl ` //
|
|
2892
|
+
# Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) `
|
|
2893
|
+
# option (google.api.http).get = "/v1/`resource=**`:getAcl"; ` ` package google.
|
|
2894
|
+
# storage.v2; service Storage ` // rpc GetAcl(GetAclRequest) returns (Acl); //
|
|
2895
|
+
# Get a data record. rpc GetData(GetDataRequest) returns (Data) ` option (google.
|
|
2896
|
+
# api.http).get = "/v2/`resource=**`"; ` ` Example of a mixin configuration:
|
|
2897
|
+
# apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.
|
|
2898
|
+
# AccessControl The mixin construct implies that all methods in `AccessControl`
|
|
2899
|
+
# are also declared with same name and request/response types in `Storage`. A
|
|
2900
|
+
# documentation generator or annotation processor will see the effective `
|
|
2901
|
+
# Storage.GetAcl` method after inherting documentation and annotations as
|
|
2902
|
+
# follows: service Storage ` // Get the underlying ACL object. rpc GetAcl(
|
|
2903
|
+
# GetAclRequest) returns (Acl) ` option (google.api.http).get = "/v2/`resource=**
|
|
2904
|
+
# `:getAcl"; ` ... ` Note how the version in the path pattern changed from `v1`
|
|
2905
|
+
# to `v2`. If the `root` field in the mixin is specified, it should be a
|
|
2906
|
+
# relative path under which inherited HTTP paths are placed. Example: apis: -
|
|
2907
|
+
# name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl
|
|
2908
|
+
# root: acls This implies the following inherited HTTP annotation: service
|
|
2909
|
+
# Storage ` // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (
|
|
2910
|
+
# Acl) ` option (google.api.http).get = "/v2/acls/`resource=**`:getAcl"; ` ... `
|
|
3487
2911
|
class Mixin
|
|
3488
2912
|
include Google::Apis::Core::Hashable
|
|
3489
2913
|
|
|
@@ -3492,8 +2916,7 @@ module Google
|
|
|
3492
2916
|
# @return [String]
|
|
3493
2917
|
attr_accessor :name
|
|
3494
2918
|
|
|
3495
|
-
# If non-empty specifies a path under which inherited HTTP paths
|
|
3496
|
-
# are rooted.
|
|
2919
|
+
# If non-empty specifies a path under which inherited HTTP paths are rooted.
|
|
3497
2920
|
# Corresponds to the JSON property `root`
|
|
3498
2921
|
# @return [String]
|
|
3499
2922
|
attr_accessor :root
|
|
@@ -3509,51 +2932,42 @@ module Google
|
|
|
3509
2932
|
end
|
|
3510
2933
|
end
|
|
3511
2934
|
|
|
3512
|
-
# An object that describes the schema of a MonitoredResource object using a
|
|
3513
|
-
#
|
|
3514
|
-
#
|
|
3515
|
-
#
|
|
3516
|
-
#
|
|
3517
|
-
#
|
|
3518
|
-
#
|
|
3519
|
-
#
|
|
3520
|
-
#
|
|
3521
|
-
#
|
|
3522
|
-
#
|
|
3523
|
-
#
|
|
3524
|
-
#
|
|
3525
|
-
#
|
|
3526
|
-
# * Maximum of default 5 service defined monitored resource descriptors
|
|
3527
|
-
# is allowed per service.
|
|
3528
|
-
# * Maximum of default 10 labels per monitored resource is allowed.
|
|
3529
|
-
# The default maximum limit can be overridden. Please follow
|
|
3530
|
-
# https://cloud.google.com/monitoring/quotas
|
|
2935
|
+
# An object that describes the schema of a MonitoredResource object using a type
|
|
2936
|
+
# name and a set of labels. For example, the monitored resource descriptor for
|
|
2937
|
+
# Google Compute Engine VM instances has a type of `"gce_instance"` and
|
|
2938
|
+
# specifies the use of the labels `"instance_id"` and `"zone"` to identify
|
|
2939
|
+
# particular VM instances. Different services can support different monitored
|
|
2940
|
+
# resource types. The following are specific rules to service defined monitored
|
|
2941
|
+
# resources for Monitoring and Logging: * The `type`, `display_name`, `
|
|
2942
|
+
# description`, `labels` and `launch_stage` fields are all required. * The first
|
|
2943
|
+
# label of the monitored resource descriptor must be `resource_container`. There
|
|
2944
|
+
# are legacy monitored resource descritptors start with `project_id`. * It must
|
|
2945
|
+
# include a `location` label. * Maximum of default 5 service defined monitored
|
|
2946
|
+
# resource descriptors is allowed per service. * Maximum of default 10 labels
|
|
2947
|
+
# per monitored resource is allowed. The default maximum limit can be overridden.
|
|
2948
|
+
# Please follow https://cloud.google.com/monitoring/quotas
|
|
3531
2949
|
class MonitoredResourceDescriptor
|
|
3532
2950
|
include Google::Apis::Core::Hashable
|
|
3533
2951
|
|
|
3534
|
-
# Optional. A detailed description of the monitored resource type that might
|
|
3535
|
-
#
|
|
2952
|
+
# Optional. A detailed description of the monitored resource type that might be
|
|
2953
|
+
# used in documentation.
|
|
3536
2954
|
# Corresponds to the JSON property `description`
|
|
3537
2955
|
# @return [String]
|
|
3538
2956
|
attr_accessor :description
|
|
3539
2957
|
|
|
3540
2958
|
# Optional. A concise name for the monitored resource type that might be
|
|
3541
|
-
# displayed in user interfaces. It should be a Title Cased Noun Phrase,
|
|
3542
|
-
#
|
|
3543
|
-
# `"Google Cloud SQL Database"`.
|
|
2959
|
+
# displayed in user interfaces. It should be a Title Cased Noun Phrase, without
|
|
2960
|
+
# any article or other determiners. For example, `"Google Cloud SQL Database"`.
|
|
3544
2961
|
# Corresponds to the JSON property `displayName`
|
|
3545
2962
|
# @return [String]
|
|
3546
2963
|
attr_accessor :display_name
|
|
3547
2964
|
|
|
3548
2965
|
# Required. A set of labels used to describe instances of this monitored
|
|
3549
|
-
# resource type.
|
|
3550
|
-
#
|
|
3551
|
-
# *
|
|
3552
|
-
#
|
|
3553
|
-
#
|
|
3554
|
-
# * The maximum length of a label name is 100 characters.
|
|
3555
|
-
# For example, an individual Google Cloud SQL database is
|
|
3556
|
-
# identified by values for the labels `database_id` and `location`.
|
|
2966
|
+
# resource type. The label key name must follow: * Only upper and lower-case
|
|
2967
|
+
# letters, digits and underscores (_) are allowed. * Label name must start with
|
|
2968
|
+
# a letter or digit. * The maximum length of a label name is 100 characters. For
|
|
2969
|
+
# example, an individual Google Cloud SQL database is identified by values for
|
|
2970
|
+
# the labels `database_id` and `location`.
|
|
3557
2971
|
# Corresponds to the JSON property `labels`
|
|
3558
2972
|
# @return [Array<Google::Apis::ServiceusageV1beta1::LabelDescriptor>]
|
|
3559
2973
|
attr_accessor :labels
|
|
@@ -3563,27 +2977,25 @@ module Google
|
|
|
3563
2977
|
# @return [String]
|
|
3564
2978
|
attr_accessor :launch_stage
|
|
3565
2979
|
|
|
3566
|
-
# Optional. The resource name of the monitored resource descriptor:
|
|
3567
|
-
#
|
|
3568
|
-
# `type`
|
|
3569
|
-
#
|
|
3570
|
-
#
|
|
3571
|
-
#
|
|
2980
|
+
# Optional. The resource name of the monitored resource descriptor: `"projects/`
|
|
2981
|
+
# project_id`/monitoredResourceDescriptors/`type`"` where `type` is the value of
|
|
2982
|
+
# the `type` field in this object and `project_id` is a project ID that provides
|
|
2983
|
+
# API-specific context for accessing the type. APIs that do not use project
|
|
2984
|
+
# information can use the resource name format `"monitoredResourceDescriptors/`
|
|
2985
|
+
# type`"`.
|
|
3572
2986
|
# Corresponds to the JSON property `name`
|
|
3573
2987
|
# @return [String]
|
|
3574
2988
|
attr_accessor :name
|
|
3575
2989
|
|
|
3576
|
-
# Required. The monitored resource type. For example, the type
|
|
3577
|
-
#
|
|
3578
|
-
#
|
|
3579
|
-
#
|
|
3580
|
-
#
|
|
3581
|
-
#
|
|
3582
|
-
#
|
|
3583
|
-
#
|
|
3584
|
-
#
|
|
3585
|
-
# is 100.
|
|
3586
|
-
# Note there are legacy service monitored resources not following this rule.
|
|
2990
|
+
# Required. The monitored resource type. For example, the type `
|
|
2991
|
+
# cloudsql_database` represents databases in Google Cloud SQL. All service
|
|
2992
|
+
# defined monitored resource types must be prefixed with the service name, in
|
|
2993
|
+
# the format of ``service name`/`relative resource name``. The relative resource
|
|
2994
|
+
# name must follow: * Only upper and lower-case letters and digits are allowed. *
|
|
2995
|
+
# It must start with upper case character and is recommended to use Upper Camel
|
|
2996
|
+
# Case style. * The maximum number of characters allowed for the
|
|
2997
|
+
# relative_resource_name is 100. Note there are legacy service monitored
|
|
2998
|
+
# resources not following this rule.
|
|
3587
2999
|
# Corresponds to the JSON property `type`
|
|
3588
3000
|
# @return [String]
|
|
3589
3001
|
attr_accessor :type
|
|
@@ -3603,75 +3015,47 @@ module Google
|
|
|
3603
3015
|
end
|
|
3604
3016
|
end
|
|
3605
3017
|
|
|
3606
|
-
# Monitoring configuration of the service.
|
|
3607
|
-
#
|
|
3608
|
-
#
|
|
3609
|
-
#
|
|
3610
|
-
#
|
|
3611
|
-
#
|
|
3612
|
-
#
|
|
3613
|
-
#
|
|
3614
|
-
# -
|
|
3615
|
-
#
|
|
3616
|
-
#
|
|
3617
|
-
#
|
|
3618
|
-
#
|
|
3619
|
-
# - key:
|
|
3620
|
-
#
|
|
3621
|
-
#
|
|
3622
|
-
#
|
|
3623
|
-
#
|
|
3624
|
-
#
|
|
3625
|
-
#
|
|
3626
|
-
#
|
|
3627
|
-
#
|
|
3628
|
-
# description: "The count of books that have been returned."
|
|
3629
|
-
# launch_stage: GA
|
|
3630
|
-
# metric_kind: DELTA
|
|
3631
|
-
# value_type: INT64
|
|
3632
|
-
# unit: "1"
|
|
3633
|
-
# labels:
|
|
3634
|
-
# - key: customer_id
|
|
3635
|
-
# description: "The id of the customer."
|
|
3636
|
-
# - name: library.googleapis.com/book/num_overdue
|
|
3637
|
-
# display_name: "Books Overdue"
|
|
3638
|
-
# description: "The current number of overdue books."
|
|
3639
|
-
# launch_stage: GA
|
|
3640
|
-
# metric_kind: GAUGE
|
|
3641
|
-
# value_type: INT64
|
|
3642
|
-
# unit: "1"
|
|
3643
|
-
# labels:
|
|
3644
|
-
# - key: customer_id
|
|
3645
|
-
# description: "The id of the customer."
|
|
3646
|
-
# monitoring:
|
|
3647
|
-
# producer_destinations:
|
|
3648
|
-
# - monitored_resource: library.googleapis.com/Branch
|
|
3649
|
-
# metrics:
|
|
3650
|
-
# - library.googleapis.com/book/returned_count
|
|
3651
|
-
# consumer_destinations:
|
|
3652
|
-
# - monitored_resource: library.googleapis.com/Branch
|
|
3653
|
-
# metrics:
|
|
3654
|
-
# - library.googleapis.com/book/returned_count
|
|
3655
|
-
# - library.googleapis.com/book/num_overdue
|
|
3018
|
+
# Monitoring configuration of the service. The example below shows how to
|
|
3019
|
+
# configure monitored resources and metrics for monitoring. In the example, a
|
|
3020
|
+
# monitored resource and two metrics are defined. The `library.googleapis.com/
|
|
3021
|
+
# book/returned_count` metric is sent to both producer and consumer projects,
|
|
3022
|
+
# whereas the `library.googleapis.com/book/num_overdue` metric is only sent to
|
|
3023
|
+
# the consumer project. monitored_resources: - type: library.googleapis.com/
|
|
3024
|
+
# Branch display_name: "Library Branch" description: "A branch of a library."
|
|
3025
|
+
# launch_stage: GA labels: - key: resource_container description: "The Cloud
|
|
3026
|
+
# container (ie. project id) for the Branch." - key: location description: "The
|
|
3027
|
+
# location of the library branch." - key: branch_id description: "The id of the
|
|
3028
|
+
# branch." metrics: - name: library.googleapis.com/book/returned_count
|
|
3029
|
+
# display_name: "Books Returned" description: "The count of books that have been
|
|
3030
|
+
# returned." launch_stage: GA metric_kind: DELTA value_type: INT64 unit: "1"
|
|
3031
|
+
# labels: - key: customer_id description: "The id of the customer." - name:
|
|
3032
|
+
# library.googleapis.com/book/num_overdue display_name: "Books Overdue"
|
|
3033
|
+
# description: "The current number of overdue books." launch_stage: GA
|
|
3034
|
+
# metric_kind: GAUGE value_type: INT64 unit: "1" labels: - key: customer_id
|
|
3035
|
+
# description: "The id of the customer." monitoring: producer_destinations: -
|
|
3036
|
+
# monitored_resource: library.googleapis.com/Branch metrics: - library.
|
|
3037
|
+
# googleapis.com/book/returned_count consumer_destinations: - monitored_resource:
|
|
3038
|
+
# library.googleapis.com/Branch metrics: - library.googleapis.com/book/
|
|
3039
|
+
# returned_count - library.googleapis.com/book/num_overdue
|
|
3656
3040
|
class Monitoring
|
|
3657
3041
|
include Google::Apis::Core::Hashable
|
|
3658
3042
|
|
|
3659
|
-
# Monitoring configurations for sending metrics to the consumer project.
|
|
3660
|
-
#
|
|
3661
|
-
#
|
|
3662
|
-
#
|
|
3663
|
-
#
|
|
3664
|
-
#
|
|
3043
|
+
# Monitoring configurations for sending metrics to the consumer project. There
|
|
3044
|
+
# can be multiple consumer destinations. A monitored resource type may appear in
|
|
3045
|
+
# multiple monitoring destinations if different aggregations are needed for
|
|
3046
|
+
# different sets of metrics associated with that monitored resource type. A
|
|
3047
|
+
# monitored resource and metric pair may only be used once in the Monitoring
|
|
3048
|
+
# configuration.
|
|
3665
3049
|
# Corresponds to the JSON property `consumerDestinations`
|
|
3666
3050
|
# @return [Array<Google::Apis::ServiceusageV1beta1::MonitoringDestination>]
|
|
3667
3051
|
attr_accessor :consumer_destinations
|
|
3668
3052
|
|
|
3669
|
-
# Monitoring configurations for sending metrics to the producer project.
|
|
3670
|
-
#
|
|
3671
|
-
#
|
|
3672
|
-
#
|
|
3673
|
-
#
|
|
3674
|
-
#
|
|
3053
|
+
# Monitoring configurations for sending metrics to the producer project. There
|
|
3054
|
+
# can be multiple producer destinations. A monitored resource type may appear in
|
|
3055
|
+
# multiple monitoring destinations if different aggregations are needed for
|
|
3056
|
+
# different sets of metrics associated with that monitored resource type. A
|
|
3057
|
+
# monitored resource and metric pair may only be used once in the Monitoring
|
|
3058
|
+
# configuration.
|
|
3675
3059
|
# Corresponds to the JSON property `producerDestinations`
|
|
3676
3060
|
# @return [Array<Google::Apis::ServiceusageV1beta1::MonitoringDestination>]
|
|
3677
3061
|
attr_accessor :producer_destinations
|
|
@@ -3687,19 +3071,19 @@ module Google
|
|
|
3687
3071
|
end
|
|
3688
3072
|
end
|
|
3689
3073
|
|
|
3690
|
-
# Configuration of a specific monitoring destination (the producer project
|
|
3691
|
-
#
|
|
3074
|
+
# Configuration of a specific monitoring destination (the producer project or
|
|
3075
|
+
# the consumer project).
|
|
3692
3076
|
class MonitoringDestination
|
|
3693
3077
|
include Google::Apis::Core::Hashable
|
|
3694
3078
|
|
|
3695
|
-
# Types of the metrics to report to this monitoring destination.
|
|
3696
|
-
#
|
|
3079
|
+
# Types of the metrics to report to this monitoring destination. Each type must
|
|
3080
|
+
# be defined in Service.metrics section.
|
|
3697
3081
|
# Corresponds to the JSON property `metrics`
|
|
3698
3082
|
# @return [Array<String>]
|
|
3699
3083
|
attr_accessor :metrics
|
|
3700
3084
|
|
|
3701
|
-
# The monitored resource type. The type must be defined in
|
|
3702
|
-
#
|
|
3085
|
+
# The monitored resource type. The type must be defined in Service.
|
|
3086
|
+
# monitored_resources section.
|
|
3703
3087
|
# Corresponds to the JSON property `monitoredResource`
|
|
3704
3088
|
# @return [String]
|
|
3705
3089
|
attr_accessor :monitored_resource
|
|
@@ -3716,27 +3100,25 @@ module Google
|
|
|
3716
3100
|
end
|
|
3717
3101
|
|
|
3718
3102
|
# OAuth scopes are a way to define data and permissions on data. For example,
|
|
3719
|
-
# there are scopes defined for "Read-only access to Google Calendar" and
|
|
3720
|
-
#
|
|
3721
|
-
#
|
|
3722
|
-
#
|
|
3723
|
-
#
|
|
3724
|
-
#
|
|
3725
|
-
#
|
|
3726
|
-
#
|
|
3727
|
-
#
|
|
3728
|
-
#
|
|
3729
|
-
#
|
|
3730
|
-
#
|
|
3731
|
-
# due to the backend requiring additional scopes or permissions.
|
|
3103
|
+
# there are scopes defined for "Read-only access to Google Calendar" and "Access
|
|
3104
|
+
# to Cloud Platform". Users can consent to a scope for an application, giving it
|
|
3105
|
+
# permission to access that data on their behalf. OAuth scope specifications
|
|
3106
|
+
# should be fairly coarse grained; a user will need to see and understand the
|
|
3107
|
+
# text description of what your scope means. In most cases: use one or at most
|
|
3108
|
+
# two OAuth scopes for an entire family of products. If your product has
|
|
3109
|
+
# multiple APIs, you should probably be sharing the OAuth scope across all of
|
|
3110
|
+
# those APIs. When you need finer grained OAuth consent screens: talk with your
|
|
3111
|
+
# product management about how developers will use them in practice. Please note
|
|
3112
|
+
# that even though each of the canonical scopes is enough for a request to be
|
|
3113
|
+
# accepted and passed to the backend, a request can still fail due to the
|
|
3114
|
+
# backend requiring additional scopes or permissions.
|
|
3732
3115
|
class OAuthRequirements
|
|
3733
3116
|
include Google::Apis::Core::Hashable
|
|
3734
3117
|
|
|
3735
|
-
# The list of publicly documented OAuth scopes that are allowed access. An
|
|
3736
|
-
#
|
|
3737
|
-
#
|
|
3738
|
-
#
|
|
3739
|
-
# https://www.googleapis.com/auth/calendar.read
|
|
3118
|
+
# The list of publicly documented OAuth scopes that are allowed access. An OAuth
|
|
3119
|
+
# token containing any of these scopes will be accepted. Example:
|
|
3120
|
+
# canonical_scopes: https://www.googleapis.com/auth/calendar, https://www.
|
|
3121
|
+
# googleapis.com/auth/calendar.read
|
|
3740
3122
|
# Corresponds to the JSON property `canonicalScopes`
|
|
3741
3123
|
# @return [String]
|
|
3742
3124
|
attr_accessor :canonical_scopes
|
|
@@ -3756,47 +3138,45 @@ module Google
|
|
|
3756
3138
|
class Operation
|
|
3757
3139
|
include Google::Apis::Core::Hashable
|
|
3758
3140
|
|
|
3759
|
-
# If the value is `false`, it means the operation is still in progress.
|
|
3760
|
-
#
|
|
3761
|
-
# available.
|
|
3141
|
+
# If the value is `false`, it means the operation is still in progress. If `true`
|
|
3142
|
+
# , the operation is completed, and either `error` or `response` is available.
|
|
3762
3143
|
# Corresponds to the JSON property `done`
|
|
3763
3144
|
# @return [Boolean]
|
|
3764
3145
|
attr_accessor :done
|
|
3765
3146
|
alias_method :done?, :done
|
|
3766
3147
|
|
|
3767
|
-
# The `Status` type defines a logical error model that is suitable for
|
|
3768
|
-
#
|
|
3769
|
-
#
|
|
3770
|
-
#
|
|
3771
|
-
#
|
|
3772
|
-
#
|
|
3148
|
+
# The `Status` type defines a logical error model that is suitable for different
|
|
3149
|
+
# programming environments, including REST APIs and RPC APIs. It is used by [
|
|
3150
|
+
# gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
|
|
3151
|
+
# data: error code, error message, and error details. You can find out more
|
|
3152
|
+
# about this error model and how to work with it in the [API Design Guide](https:
|
|
3153
|
+
# //cloud.google.com/apis/design/errors).
|
|
3773
3154
|
# Corresponds to the JSON property `error`
|
|
3774
3155
|
# @return [Google::Apis::ServiceusageV1beta1::Status]
|
|
3775
3156
|
attr_accessor :error
|
|
3776
3157
|
|
|
3777
|
-
# Service-specific metadata associated with the operation.
|
|
3778
|
-
#
|
|
3779
|
-
#
|
|
3780
|
-
#
|
|
3158
|
+
# Service-specific metadata associated with the operation. It typically contains
|
|
3159
|
+
# progress information and common metadata such as create time. Some services
|
|
3160
|
+
# might not provide such metadata. Any method that returns a long-running
|
|
3161
|
+
# operation should document the metadata type, if any.
|
|
3781
3162
|
# Corresponds to the JSON property `metadata`
|
|
3782
3163
|
# @return [Hash<String,Object>]
|
|
3783
3164
|
attr_accessor :metadata
|
|
3784
3165
|
|
|
3785
3166
|
# The server-assigned name, which is only unique within the same service that
|
|
3786
|
-
# originally returns it. If you use the default HTTP mapping, the
|
|
3787
|
-
#
|
|
3167
|
+
# originally returns it. If you use the default HTTP mapping, the `name` should
|
|
3168
|
+
# be a resource name ending with `operations/`unique_id``.
|
|
3788
3169
|
# Corresponds to the JSON property `name`
|
|
3789
3170
|
# @return [String]
|
|
3790
3171
|
attr_accessor :name
|
|
3791
3172
|
|
|
3792
|
-
# The normal response of the operation in case of success.
|
|
3793
|
-
# method returns no data on success, such as `Delete`, the response is
|
|
3794
|
-
#
|
|
3795
|
-
#
|
|
3796
|
-
#
|
|
3797
|
-
#
|
|
3798
|
-
#
|
|
3799
|
-
# `TakeSnapshotResponse`.
|
|
3173
|
+
# The normal response of the operation in case of success. If the original
|
|
3174
|
+
# method returns no data on success, such as `Delete`, the response is `google.
|
|
3175
|
+
# protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`,
|
|
3176
|
+
# the response should be the resource. For other methods, the response should
|
|
3177
|
+
# have the type `XxxResponse`, where `Xxx` is the original method name. For
|
|
3178
|
+
# example, if the original method name is `TakeSnapshot()`, the inferred
|
|
3179
|
+
# response type is `TakeSnapshotResponse`.
|
|
3800
3180
|
# Corresponds to the JSON property `response`
|
|
3801
3181
|
# @return [Hash<String,Object>]
|
|
3802
3182
|
attr_accessor :response
|
|
@@ -3819,8 +3199,7 @@ module Google
|
|
|
3819
3199
|
class OperationMetadata
|
|
3820
3200
|
include Google::Apis::Core::Hashable
|
|
3821
3201
|
|
|
3822
|
-
# The full name of the resources that this operation is directly
|
|
3823
|
-
# associated with.
|
|
3202
|
+
# The full name of the resources that this operation is directly associated with.
|
|
3824
3203
|
# Corresponds to the JSON property `resourceNames`
|
|
3825
3204
|
# @return [Array<String>]
|
|
3826
3205
|
attr_accessor :resource_names
|
|
@@ -3841,17 +3220,17 @@ module Google
|
|
|
3841
3220
|
include Google::Apis::Core::Hashable
|
|
3842
3221
|
|
|
3843
3222
|
# The option's name. For protobuf built-in options (options defined in
|
|
3844
|
-
# descriptor.proto), this is the short name. For example, `"map_entry"`.
|
|
3845
|
-
#
|
|
3846
|
-
#
|
|
3223
|
+
# descriptor.proto), this is the short name. For example, `"map_entry"`. For
|
|
3224
|
+
# custom options, it should be the fully-qualified name. For example, `"google.
|
|
3225
|
+
# api.http"`.
|
|
3847
3226
|
# Corresponds to the JSON property `name`
|
|
3848
3227
|
# @return [String]
|
|
3849
3228
|
attr_accessor :name
|
|
3850
3229
|
|
|
3851
|
-
# The option's value packed in an Any message. If the value is a primitive,
|
|
3852
|
-
#
|
|
3853
|
-
#
|
|
3854
|
-
#
|
|
3230
|
+
# The option's value packed in an Any message. If the value is a primitive, the
|
|
3231
|
+
# corresponding wrapper type defined in google/protobuf/wrappers.proto should be
|
|
3232
|
+
# used. If the value is an enum, it should be stored as an int32 value using the
|
|
3233
|
+
# google.protobuf.Int32Value type.
|
|
3855
3234
|
# Corresponds to the JSON property `value`
|
|
3856
3235
|
# @return [Hash<String,Object>]
|
|
3857
3236
|
attr_accessor :value
|
|
@@ -3871,9 +3250,9 @@ module Google
|
|
|
3871
3250
|
class OverrideInlineSource
|
|
3872
3251
|
include Google::Apis::Core::Hashable
|
|
3873
3252
|
|
|
3874
|
-
# The overrides to create.
|
|
3875
|
-
#
|
|
3876
|
-
#
|
|
3253
|
+
# The overrides to create. Each override must have a value for 'metric' and '
|
|
3254
|
+
# unit', to specify which metric and which limit the override should be applied
|
|
3255
|
+
# to.
|
|
3877
3256
|
# Corresponds to the JSON property `overrides`
|
|
3878
3257
|
# @return [Array<Google::Apis::ServiceusageV1beta1::QuotaOverride>]
|
|
3879
3258
|
attr_accessor :overrides
|
|
@@ -3893,32 +3272,25 @@ module Google
|
|
|
3893
3272
|
class Page
|
|
3894
3273
|
include Google::Apis::Core::Hashable
|
|
3895
3274
|
|
|
3896
|
-
# The Markdown content of the page. You can use
|
|
3897
|
-
#
|
|
3275
|
+
# The Markdown content of the page. You can use (== include `path` ==) to
|
|
3276
|
+
# include content from a Markdown file.
|
|
3898
3277
|
# Corresponds to the JSON property `content`
|
|
3899
3278
|
# @return [String]
|
|
3900
3279
|
attr_accessor :content
|
|
3901
3280
|
|
|
3902
|
-
# The name of the page. It will be used as an identity of the page to
|
|
3903
|
-
#
|
|
3904
|
-
#
|
|
3905
|
-
#
|
|
3906
|
-
#
|
|
3907
|
-
#
|
|
3908
|
-
#
|
|
3909
|
-
# content: (== include tutorial.md ==)
|
|
3910
|
-
# subpages:
|
|
3911
|
-
# - name: Java
|
|
3912
|
-
# content: (== include tutorial_java.md ==)
|
|
3913
|
-
# </code></pre>
|
|
3914
|
-
# You can reference `Java` page using Markdown reference link syntax:
|
|
3915
|
-
# `Java`.
|
|
3281
|
+
# The name of the page. It will be used as an identity of the page to generate
|
|
3282
|
+
# URI of the page, text of the link to this page in navigation, etc. The full
|
|
3283
|
+
# page name (start from the root page name to this page concatenated with `.`)
|
|
3284
|
+
# can be used as reference to the page in your documentation. For example: pages:
|
|
3285
|
+
# - name: Tutorial content: (== include tutorial.md ==) subpages: - name: Java
|
|
3286
|
+
# content: (== include tutorial_java.md ==) You can reference `Java` page using
|
|
3287
|
+
# Markdown reference link syntax: `Java`.
|
|
3916
3288
|
# Corresponds to the JSON property `name`
|
|
3917
3289
|
# @return [String]
|
|
3918
3290
|
attr_accessor :name
|
|
3919
3291
|
|
|
3920
|
-
# Subpages of this page. The order of subpages specified here will be
|
|
3921
|
-
#
|
|
3292
|
+
# Subpages of this page. The order of subpages specified here will be honored in
|
|
3293
|
+
# the generated docset.
|
|
3922
3294
|
# Corresponds to the JSON property `subpages`
|
|
3923
3295
|
# @return [Array<Google::Apis::ServiceusageV1beta1::Page>]
|
|
3924
3296
|
attr_accessor :subpages
|
|
@@ -3935,46 +3307,25 @@ module Google
|
|
|
3935
3307
|
end
|
|
3936
3308
|
end
|
|
3937
3309
|
|
|
3938
|
-
# Quota configuration helps to achieve fairness and budgeting in service
|
|
3939
|
-
#
|
|
3940
|
-
#
|
|
3941
|
-
#
|
|
3942
|
-
#
|
|
3943
|
-
#
|
|
3944
|
-
#
|
|
3945
|
-
#
|
|
3946
|
-
#
|
|
3947
|
-
#
|
|
3948
|
-
#
|
|
3949
|
-
# -
|
|
3950
|
-
#
|
|
3951
|
-
#
|
|
3952
|
-
#
|
|
3953
|
-
#
|
|
3954
|
-
#
|
|
3955
|
-
#
|
|
3956
|
-
#
|
|
3957
|
-
# # consuming at twice rate as the DeleteBook method.
|
|
3958
|
-
# metric_rules:
|
|
3959
|
-
# - selector: "*"
|
|
3960
|
-
# metric_costs:
|
|
3961
|
-
# library.googleapis.com/read_calls: 1
|
|
3962
|
-
# - selector: google.example.library.v1.LibraryService.UpdateBook
|
|
3963
|
-
# metric_costs:
|
|
3964
|
-
# library.googleapis.com/write_calls: 2
|
|
3965
|
-
# - selector: google.example.library.v1.LibraryService.DeleteBook
|
|
3966
|
-
# metric_costs:
|
|
3967
|
-
# library.googleapis.com/write_calls: 1
|
|
3968
|
-
# Corresponding Metric definition:
|
|
3969
|
-
# metrics:
|
|
3970
|
-
# - name: library.googleapis.com/read_calls
|
|
3971
|
-
# display_name: Read requests
|
|
3972
|
-
# metric_kind: DELTA
|
|
3973
|
-
# value_type: INT64
|
|
3974
|
-
# - name: library.googleapis.com/write_calls
|
|
3975
|
-
# display_name: Write requests
|
|
3976
|
-
# metric_kind: DELTA
|
|
3977
|
-
# value_type: INT64
|
|
3310
|
+
# Quota configuration helps to achieve fairness and budgeting in service usage.
|
|
3311
|
+
# The metric based quota configuration works this way: - The service
|
|
3312
|
+
# configuration defines a set of metrics. - For API calls, the quota.
|
|
3313
|
+
# metric_rules maps methods to metrics with corresponding costs. - The quota.
|
|
3314
|
+
# limits defines limits on the metrics, which will be used for quota checks at
|
|
3315
|
+
# runtime. An example quota configuration in yaml format: quota: limits: - name:
|
|
3316
|
+
# apiWriteQpsPerProject metric: library.googleapis.com/write_calls unit: "1/min/`
|
|
3317
|
+
# project`" # rate limit for consumer projects values: STANDARD: 10000 # The
|
|
3318
|
+
# metric rules bind all methods to the read_calls metric, # except for the
|
|
3319
|
+
# UpdateBook and DeleteBook methods. These two methods # are mapped to the
|
|
3320
|
+
# write_calls metric, with the UpdateBook method # consuming at twice rate as
|
|
3321
|
+
# the DeleteBook method. metric_rules: - selector: "*" metric_costs: library.
|
|
3322
|
+
# googleapis.com/read_calls: 1 - selector: google.example.library.v1.
|
|
3323
|
+
# LibraryService.UpdateBook metric_costs: library.googleapis.com/write_calls: 2 -
|
|
3324
|
+
# selector: google.example.library.v1.LibraryService.DeleteBook metric_costs:
|
|
3325
|
+
# library.googleapis.com/write_calls: 1 Corresponding Metric definition: metrics:
|
|
3326
|
+
# - name: library.googleapis.com/read_calls display_name: Read requests
|
|
3327
|
+
# metric_kind: DELTA value_type: INT64 - name: library.googleapis.com/
|
|
3328
|
+
# write_calls display_name: Write requests metric_kind: DELTA value_type: INT64
|
|
3978
3329
|
class Quota
|
|
3979
3330
|
include Google::Apis::Core::Hashable
|
|
3980
3331
|
|
|
@@ -3983,8 +3334,8 @@ module Google
|
|
|
3983
3334
|
# @return [Array<Google::Apis::ServiceusageV1beta1::QuotaLimit>]
|
|
3984
3335
|
attr_accessor :limits
|
|
3985
3336
|
|
|
3986
|
-
# List of `MetricRule` definitions, each one mapping a selected method to one
|
|
3987
|
-
#
|
|
3337
|
+
# List of `MetricRule` definitions, each one mapping a selected method to one or
|
|
3338
|
+
# more metrics.
|
|
3988
3339
|
# Corresponds to the JSON property `metricRules`
|
|
3989
3340
|
# @return [Array<Google::Apis::ServiceusageV1beta1::MetricRule>]
|
|
3990
3341
|
attr_accessor :metric_rules
|
|
@@ -4020,20 +3371,19 @@ module Google
|
|
|
4020
3371
|
# @return [Fixnum]
|
|
4021
3372
|
attr_accessor :default_limit
|
|
4022
3373
|
|
|
4023
|
-
# The dimensions of this quota bucket.
|
|
4024
|
-
#
|
|
4025
|
-
#
|
|
4026
|
-
#
|
|
4027
|
-
#
|
|
4028
|
-
#
|
|
4029
|
-
# specified
|
|
4030
|
-
# specified overrides apply only in that region.
|
|
3374
|
+
# The dimensions of this quota bucket. If this map is empty, this is the global
|
|
3375
|
+
# bucket, which is the default quota value applied to all requests that do not
|
|
3376
|
+
# have a more specific override. If this map is nonempty, the default limit,
|
|
3377
|
+
# effective limit, and quota overrides apply only to requests that have the
|
|
3378
|
+
# dimensions given in the map. For example, if the map has key "region" and
|
|
3379
|
+
# value "us-east-1", then the specified effective limit is only effective in
|
|
3380
|
+
# that region, and the specified overrides apply only in that region.
|
|
4031
3381
|
# Corresponds to the JSON property `dimensions`
|
|
4032
3382
|
# @return [Hash<String,String>]
|
|
4033
3383
|
attr_accessor :dimensions
|
|
4034
3384
|
|
|
4035
|
-
# The effective limit of this quota bucket. Equal to default_limit if there
|
|
4036
|
-
#
|
|
3385
|
+
# The effective limit of this quota bucket. Equal to default_limit if there are
|
|
3386
|
+
# no overrides.
|
|
4037
3387
|
# Corresponds to the JSON property `effectiveLimit`
|
|
4038
3388
|
# @return [Fixnum]
|
|
4039
3389
|
attr_accessor :effective_limit
|
|
@@ -4059,95 +3409,89 @@ module Google
|
|
|
4059
3409
|
end
|
|
4060
3410
|
|
|
4061
3411
|
# `QuotaLimit` defines a specific limit that applies over a specified duration
|
|
4062
|
-
# for a limit type. There can be at most one limit for a duration and limit
|
|
4063
|
-
#
|
|
3412
|
+
# for a limit type. There can be at most one limit for a duration and limit type
|
|
3413
|
+
# combination defined within a `QuotaGroup`.
|
|
4064
3414
|
class QuotaLimit
|
|
4065
3415
|
include Google::Apis::Core::Hashable
|
|
4066
3416
|
|
|
4067
|
-
# Default number of tokens that can be consumed during the specified
|
|
4068
|
-
#
|
|
4069
|
-
#
|
|
4070
|
-
#
|
|
4071
|
-
#
|
|
4072
|
-
#
|
|
4073
|
-
#
|
|
4074
|
-
# Used by group-based quotas only.
|
|
3417
|
+
# Default number of tokens that can be consumed during the specified duration.
|
|
3418
|
+
# This is the number of tokens assigned when a client application developer
|
|
3419
|
+
# activates the service for his/her project. Specifying a value of 0 will block
|
|
3420
|
+
# all requests. This can be used if you are provisioning quota to selected
|
|
3421
|
+
# consumers and blocking others. Similarly, a value of -1 will indicate an
|
|
3422
|
+
# unlimited quota. No other negative values are allowed. Used by group-based
|
|
3423
|
+
# quotas only.
|
|
4075
3424
|
# Corresponds to the JSON property `defaultLimit`
|
|
4076
3425
|
# @return [Fixnum]
|
|
4077
3426
|
attr_accessor :default_limit
|
|
4078
3427
|
|
|
4079
|
-
# Optional. User-visible, extended description for this quota limit.
|
|
4080
|
-
#
|
|
4081
|
-
#
|
|
3428
|
+
# Optional. User-visible, extended description for this quota limit. Should be
|
|
3429
|
+
# used only when more context is needed to understand this limit than provided
|
|
3430
|
+
# by the limit's display name (see: `display_name`).
|
|
4082
3431
|
# Corresponds to the JSON property `description`
|
|
4083
3432
|
# @return [String]
|
|
4084
3433
|
attr_accessor :description
|
|
4085
3434
|
|
|
4086
|
-
# User-visible display name for this limit.
|
|
4087
|
-
#
|
|
4088
|
-
#
|
|
4089
|
-
#
|
|
3435
|
+
# User-visible display name for this limit. Optional. If not set, the UI will
|
|
3436
|
+
# provide a default display name based on the quota configuration. This field
|
|
3437
|
+
# can be used to override the default display name generated from the
|
|
3438
|
+
# configuration.
|
|
4090
3439
|
# Corresponds to the JSON property `displayName`
|
|
4091
3440
|
# @return [String]
|
|
4092
3441
|
attr_accessor :display_name
|
|
4093
3442
|
|
|
4094
|
-
# Duration of this limit in textual notation. Must be "100s" or "1d".
|
|
4095
|
-
#
|
|
3443
|
+
# Duration of this limit in textual notation. Must be "100s" or "1d". Used by
|
|
3444
|
+
# group-based quotas only.
|
|
4096
3445
|
# Corresponds to the JSON property `duration`
|
|
4097
3446
|
# @return [String]
|
|
4098
3447
|
attr_accessor :duration
|
|
4099
3448
|
|
|
4100
|
-
# Free tier value displayed in the Developers Console for this limit.
|
|
4101
|
-
#
|
|
4102
|
-
#
|
|
4103
|
-
#
|
|
4104
|
-
#
|
|
4105
|
-
#
|
|
4106
|
-
# Used by group-based quotas only.
|
|
3449
|
+
# Free tier value displayed in the Developers Console for this limit. The free
|
|
3450
|
+
# tier is the number of tokens that will be subtracted from the billed amount
|
|
3451
|
+
# when billing is enabled. This field can only be set on a limit with duration "
|
|
3452
|
+
# 1d", in a billable group; it is invalid on any other limit. If this field is
|
|
3453
|
+
# not set, it defaults to 0, indicating that there is no free tier for this
|
|
3454
|
+
# service. Used by group-based quotas only.
|
|
4107
3455
|
# Corresponds to the JSON property `freeTier`
|
|
4108
3456
|
# @return [Fixnum]
|
|
4109
3457
|
attr_accessor :free_tier
|
|
4110
3458
|
|
|
4111
|
-
# Maximum number of tokens that can be consumed during the specified
|
|
4112
|
-
#
|
|
4113
|
-
#
|
|
4114
|
-
#
|
|
4115
|
-
#
|
|
4116
|
-
#
|
|
4117
|
-
# Used by group-based quotas only.
|
|
3459
|
+
# Maximum number of tokens that can be consumed during the specified duration.
|
|
3460
|
+
# Client application developers can override the default limit up to this
|
|
3461
|
+
# maximum. If specified, this value cannot be set to a value less than the
|
|
3462
|
+
# default limit. If not specified, it is set to the default limit. To allow
|
|
3463
|
+
# clients to apply overrides with no upper bound, set this to -1, indicating
|
|
3464
|
+
# unlimited maximum quota. Used by group-based quotas only.
|
|
4118
3465
|
# Corresponds to the JSON property `maxLimit`
|
|
4119
3466
|
# @return [Fixnum]
|
|
4120
3467
|
attr_accessor :max_limit
|
|
4121
3468
|
|
|
4122
|
-
# The name of the metric this quota limit applies to. The quota limits with
|
|
4123
|
-
#
|
|
3469
|
+
# The name of the metric this quota limit applies to. The quota limits with the
|
|
3470
|
+
# same metric will be checked together during runtime. The metric must be
|
|
4124
3471
|
# defined within the service config.
|
|
4125
3472
|
# Corresponds to the JSON property `metric`
|
|
4126
3473
|
# @return [String]
|
|
4127
3474
|
attr_accessor :metric
|
|
4128
3475
|
|
|
4129
|
-
# Name of the quota limit.
|
|
4130
|
-
#
|
|
4131
|
-
#
|
|
4132
|
-
# The maximum length of the limit name is 64 characters.
|
|
3476
|
+
# Name of the quota limit. The name must be provided, and it must be unique
|
|
3477
|
+
# within the service. The name can only include alphanumeric characters as well
|
|
3478
|
+
# as '-'. The maximum length of the limit name is 64 characters.
|
|
4133
3479
|
# Corresponds to the JSON property `name`
|
|
4134
3480
|
# @return [String]
|
|
4135
3481
|
attr_accessor :name
|
|
4136
3482
|
|
|
4137
|
-
# Specify the unit of the quota limit. It uses the same syntax as
|
|
4138
|
-
#
|
|
4139
|
-
#
|
|
4140
|
-
#
|
|
4141
|
-
#
|
|
4142
|
-
# Note: the order of unit components is insignificant.
|
|
4143
|
-
# The "1" at the beginning is required to follow the metric unit syntax.
|
|
3483
|
+
# Specify the unit of the quota limit. It uses the same syntax as Metric.unit.
|
|
3484
|
+
# The supported unit kinds are determined by the quota backend system. Here are
|
|
3485
|
+
# some examples: * "1/min/`project`" for quota per minute per project. Note: the
|
|
3486
|
+
# order of unit components is insignificant. The "1" at the beginning is
|
|
3487
|
+
# required to follow the metric unit syntax.
|
|
4144
3488
|
# Corresponds to the JSON property `unit`
|
|
4145
3489
|
# @return [String]
|
|
4146
3490
|
attr_accessor :unit
|
|
4147
3491
|
|
|
4148
3492
|
# Tiered limit values. You must specify this as a key:value pair, with an
|
|
4149
|
-
# integer value that is the maximum number of requests allowed for the
|
|
4150
|
-
#
|
|
3493
|
+
# integer value that is the maximum number of requests allowed for the specified
|
|
3494
|
+
# unit. Currently only STANDARD is supported.
|
|
4151
3495
|
# Corresponds to the JSON property `values`
|
|
4152
3496
|
# @return [Hash<String,Fixnum>]
|
|
4153
3497
|
attr_accessor :values
|
|
@@ -4175,66 +3519,58 @@ module Google
|
|
|
4175
3519
|
class QuotaOverride
|
|
4176
3520
|
include Google::Apis::Core::Hashable
|
|
4177
3521
|
|
|
4178
|
-
# The resource name of the ancestor that requested the override. For example:
|
|
4179
|
-
#
|
|
4180
|
-
# Used by admin overrides only.
|
|
3522
|
+
# The resource name of the ancestor that requested the override. For example: "
|
|
3523
|
+
# organizations/12345" or "folders/67890". Used by admin overrides only.
|
|
4181
3524
|
# Corresponds to the JSON property `adminOverrideAncestor`
|
|
4182
3525
|
# @return [String]
|
|
4183
3526
|
attr_accessor :admin_override_ancestor
|
|
4184
3527
|
|
|
4185
3528
|
# If this map is nonempty, then this override applies only to specific values
|
|
4186
|
-
# for dimensions defined in the limit unit.
|
|
4187
|
-
#
|
|
4188
|
-
#
|
|
4189
|
-
#
|
|
4190
|
-
#
|
|
4191
|
-
#
|
|
4192
|
-
#
|
|
4193
|
-
#
|
|
4194
|
-
#
|
|
4195
|
-
#
|
|
4196
|
-
#
|
|
4197
|
-
#
|
|
4198
|
-
#
|
|
4199
|
-
# * If "zone" appears as a key, its value must be a valid Cloud zone.
|
|
4200
|
-
# * If any valid key other than "region" or "zone" appears in the map, then
|
|
4201
|
-
# all valid keys other than "region" or "zone" must also appear in the
|
|
4202
|
-
# map.
|
|
3529
|
+
# for dimensions defined in the limit unit. For example, an override on a limit
|
|
3530
|
+
# with the unit 1/`project`/`region` could contain an entry with the key "region"
|
|
3531
|
+
# and the value "us-east-1"; the override is only applied to quota consumed in
|
|
3532
|
+
# that region. This map has the following restrictions: * Keys that are not
|
|
3533
|
+
# defined in the limit's unit are not valid keys. Any string appearing in `
|
|
3534
|
+
# brackets` in the unit (besides `project` or `user`) is a defined key. * "
|
|
3535
|
+
# project" is not a valid key; the project is already specified in the parent
|
|
3536
|
+
# resource name. * "user" is not a valid key; the API does not support quota
|
|
3537
|
+
# overrides that apply only to a specific user. * If "region" appears as a key,
|
|
3538
|
+
# its value must be a valid Cloud region. * If "zone" appears as a key, its
|
|
3539
|
+
# value must be a valid Cloud zone. * If any valid key other than "region" or "
|
|
3540
|
+
# zone" appears in the map, then all valid keys other than "region" or "zone"
|
|
3541
|
+
# must also appear in the map.
|
|
4203
3542
|
# Corresponds to the JSON property `dimensions`
|
|
4204
3543
|
# @return [Hash<String,String>]
|
|
4205
3544
|
attr_accessor :dimensions
|
|
4206
3545
|
|
|
4207
|
-
# The name of the metric to which this override applies.
|
|
4208
|
-
#
|
|
4209
|
-
# `compute.googleapis.com/cpus`
|
|
3546
|
+
# The name of the metric to which this override applies. An example name would
|
|
3547
|
+
# be: `compute.googleapis.com/cpus`
|
|
4210
3548
|
# Corresponds to the JSON property `metric`
|
|
4211
3549
|
# @return [String]
|
|
4212
3550
|
attr_accessor :metric
|
|
4213
3551
|
|
|
4214
|
-
# The resource name of the override.
|
|
4215
|
-
#
|
|
4216
|
-
#
|
|
4217
|
-
# `projects/123/services/
|
|
4218
|
-
# googleapis.com%2Fcpus/
|
|
4219
|
-
#
|
|
4220
|
-
#
|
|
4221
|
-
#
|
|
4222
|
-
# its component strings, since its representation could change in the future.
|
|
3552
|
+
# The resource name of the override. This name is generated by the server when
|
|
3553
|
+
# the override is created. Example names would be: `projects/123/services/
|
|
3554
|
+
# compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/
|
|
3555
|
+
# limits/%2Fproject%2Fregion/adminOverrides/4a3f2c1d` `projects/123/services/
|
|
3556
|
+
# compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/
|
|
3557
|
+
# limits/%2Fproject%2Fregion/consumerOverrides/4a3f2c1d` The resource name is
|
|
3558
|
+
# intended to be opaque and should not be parsed for its component strings,
|
|
3559
|
+
# since its representation could change in the future.
|
|
4223
3560
|
# Corresponds to the JSON property `name`
|
|
4224
3561
|
# @return [String]
|
|
4225
3562
|
attr_accessor :name
|
|
4226
3563
|
|
|
4227
|
-
# The overriding quota limit value.
|
|
4228
|
-
#
|
|
3564
|
+
# The overriding quota limit value. Can be any nonnegative integer, or -1 (
|
|
3565
|
+
# unlimited quota).
|
|
4229
3566
|
# Corresponds to the JSON property `overrideValue`
|
|
4230
3567
|
# @return [Fixnum]
|
|
4231
3568
|
attr_accessor :override_value
|
|
4232
3569
|
|
|
4233
|
-
# The limit unit of the limit to which this override applies.
|
|
4234
|
-
#
|
|
4235
|
-
#
|
|
4236
|
-
#
|
|
4237
|
-
# the literal characters ``` and ``` occur in the string.
|
|
3570
|
+
# The limit unit of the limit to which this override applies. An example unit
|
|
3571
|
+
# would be: `1/`project`/`region`` Note that ``project`` and ``region`` are not
|
|
3572
|
+
# placeholders in this example; the literal characters ``` and ``` occur in the
|
|
3573
|
+
# string.
|
|
4238
3574
|
# Corresponds to the JSON property `unit`
|
|
4239
3575
|
# @return [String]
|
|
4240
3576
|
attr_accessor :unit
|
|
@@ -4263,16 +3599,13 @@ module Google
|
|
|
4263
3599
|
# @return [Google::Apis::ServiceusageV1beta1::ServiceConfig]
|
|
4264
3600
|
attr_accessor :config
|
|
4265
3601
|
|
|
4266
|
-
# The resource name of the consumer and service.
|
|
4267
|
-
#
|
|
4268
|
-
# - projects/123/services/serviceusage.googleapis.com
|
|
3602
|
+
# The resource name of the consumer and service. A valid name would be: -
|
|
3603
|
+
# projects/123/services/serviceusage.googleapis.com
|
|
4269
3604
|
# Corresponds to the JSON property `name`
|
|
4270
3605
|
# @return [String]
|
|
4271
3606
|
attr_accessor :name
|
|
4272
3607
|
|
|
4273
|
-
# The resource name of the consumer.
|
|
4274
|
-
# A valid name would be:
|
|
4275
|
-
# - projects/123
|
|
3608
|
+
# The resource name of the consumer. A valid name would be: - projects/123
|
|
4276
3609
|
# Corresponds to the JSON property `parent`
|
|
4277
3610
|
# @return [String]
|
|
4278
3611
|
attr_accessor :parent
|
|
@@ -4305,129 +3638,76 @@ module Google
|
|
|
4305
3638
|
# @return [Array<Google::Apis::ServiceusageV1beta1::Api>]
|
|
4306
3639
|
attr_accessor :apis
|
|
4307
3640
|
|
|
4308
|
-
# `Authentication` defines the authentication configuration for an API.
|
|
4309
|
-
#
|
|
4310
|
-
#
|
|
4311
|
-
#
|
|
4312
|
-
#
|
|
4313
|
-
# - id: google_calendar_auth
|
|
4314
|
-
# jwks_uri: https://www.googleapis.com/oauth2/v1/certs
|
|
4315
|
-
# issuer: https://securetoken.google.com
|
|
4316
|
-
# rules:
|
|
4317
|
-
# - selector: "*"
|
|
4318
|
-
# requirements:
|
|
4319
|
-
# provider_id: google_calendar_auth
|
|
3641
|
+
# `Authentication` defines the authentication configuration for an API. Example
|
|
3642
|
+
# for an API targeted for external use: name: calendar.googleapis.com
|
|
3643
|
+
# authentication: providers: - id: google_calendar_auth jwks_uri: https://www.
|
|
3644
|
+
# googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: -
|
|
3645
|
+
# selector: "*" requirements: provider_id: google_calendar_auth
|
|
4320
3646
|
# Corresponds to the JSON property `authentication`
|
|
4321
3647
|
# @return [Google::Apis::ServiceusageV1beta1::Authentication]
|
|
4322
3648
|
attr_accessor :authentication
|
|
4323
3649
|
|
|
4324
|
-
# `Documentation` provides the information for describing a service.
|
|
4325
|
-
#
|
|
4326
|
-
#
|
|
4327
|
-
#
|
|
4328
|
-
#
|
|
4329
|
-
#
|
|
4330
|
-
#
|
|
4331
|
-
#
|
|
4332
|
-
#
|
|
4333
|
-
#
|
|
4334
|
-
#
|
|
4335
|
-
#
|
|
4336
|
-
#
|
|
4337
|
-
#
|
|
4338
|
-
#
|
|
4339
|
-
#
|
|
4340
|
-
#
|
|
4341
|
-
#
|
|
4342
|
-
#
|
|
4343
|
-
#
|
|
4344
|
-
#
|
|
4345
|
-
#
|
|
4346
|
-
#
|
|
4347
|
-
#
|
|
4348
|
-
#
|
|
4349
|
-
#
|
|
4350
|
-
# a documentation fragment is embedded.
|
|
4351
|
-
# Documentation from the IDL is merged with documentation defined
|
|
4352
|
-
# via the config at normalization time, where documentation provided
|
|
4353
|
-
# by config rules overrides IDL provided.
|
|
4354
|
-
# A number of constructs specific to the API platform are supported
|
|
4355
|
-
# in documentation text.
|
|
4356
|
-
# In order to reference a proto element, the following
|
|
4357
|
-
# notation can be used:
|
|
4358
|
-
# <pre><code>[fully.qualified.proto.name][]</code></pre>
|
|
4359
|
-
# To override the display text used for the link, this can be used:
|
|
4360
|
-
# <pre><code>[display text][fully.qualified.proto.name]</code></pre>
|
|
4361
|
-
# Text can be excluded from doc using the following notation:
|
|
4362
|
-
# <pre><code>(-- internal comment --)</code></pre>
|
|
4363
|
-
# A few directives are available in documentation. Note that
|
|
4364
|
-
# directives must appear on a single line to be properly
|
|
4365
|
-
# identified. The `include` directive includes a markdown file from
|
|
4366
|
-
# an external source:
|
|
4367
|
-
# <pre><code>(== include path/to/file ==)</code></pre>
|
|
4368
|
-
# The `resource_for` directive marks a message to be the resource of
|
|
4369
|
-
# a collection in REST view. If it is not specified, tools attempt
|
|
4370
|
-
# to infer the resource from the operations in a collection:
|
|
4371
|
-
# <pre><code>(== resource_for v1.shelves.books ==)</code></pre>
|
|
4372
|
-
# The directive `suppress_warning` does not directly affect documentation
|
|
4373
|
-
# and is documented together with service config validation.
|
|
3650
|
+
# `Documentation` provides the information for describing a service. Example:
|
|
3651
|
+
# documentation: summary: > The Google Calendar API gives access to most
|
|
3652
|
+
# calendar features. pages: - name: Overview content: (== include google/foo/
|
|
3653
|
+
# overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==
|
|
3654
|
+
# ) subpages; - name: Java content: (== include google/foo/tutorial_java.md ==)
|
|
3655
|
+
# rules: - selector: google.calendar.Calendar.Get description: > ... - selector:
|
|
3656
|
+
# google.calendar.Calendar.Put description: > ... Documentation is provided in
|
|
3657
|
+
# markdown syntax. In addition to standard markdown features, definition lists,
|
|
3658
|
+
# tables and fenced code blocks are supported. Section headers can be provided
|
|
3659
|
+
# and are interpreted relative to the section nesting of the context where a
|
|
3660
|
+
# documentation fragment is embedded. Documentation from the IDL is merged with
|
|
3661
|
+
# documentation defined via the config at normalization time, where
|
|
3662
|
+
# documentation provided by config rules overrides IDL provided. A number of
|
|
3663
|
+
# constructs specific to the API platform are supported in documentation text.
|
|
3664
|
+
# In order to reference a proto element, the following notation can be used: [
|
|
3665
|
+
# fully.qualified.proto.name][] To override the display text used for the link,
|
|
3666
|
+
# this can be used: [display text][fully.qualified.proto.name] Text can be
|
|
3667
|
+
# excluded from doc using the following notation: (-- internal comment --) A few
|
|
3668
|
+
# directives are available in documentation. Note that directives must appear on
|
|
3669
|
+
# a single line to be properly identified. The `include` directive includes a
|
|
3670
|
+
# markdown file from an external source: (== include path/to/file ==) The `
|
|
3671
|
+
# resource_for` directive marks a message to be the resource of a collection in
|
|
3672
|
+
# REST view. If it is not specified, tools attempt to infer the resource from
|
|
3673
|
+
# the operations in a collection: (== resource_for v1.shelves.books ==) The
|
|
3674
|
+
# directive `suppress_warning` does not directly affect documentation and is
|
|
3675
|
+
# documented together with service config validation.
|
|
4374
3676
|
# Corresponds to the JSON property `documentation`
|
|
4375
3677
|
# @return [Google::Apis::ServiceusageV1beta1::Documentation]
|
|
4376
3678
|
attr_accessor :documentation
|
|
4377
3679
|
|
|
4378
|
-
# Configuration for network endpoints. Contains only the names and aliases
|
|
4379
|
-
#
|
|
3680
|
+
# Configuration for network endpoints. Contains only the names and aliases of
|
|
3681
|
+
# the endpoints.
|
|
4380
3682
|
# Corresponds to the JSON property `endpoints`
|
|
4381
3683
|
# @return [Array<Google::Apis::ServiceusageV1beta1::Endpoint>]
|
|
4382
3684
|
attr_accessor :endpoints
|
|
4383
3685
|
|
|
4384
|
-
# The DNS address at which this service is available.
|
|
4385
|
-
#
|
|
4386
|
-
# `calendar.googleapis.com`.
|
|
3686
|
+
# The DNS address at which this service is available. An example DNS address
|
|
3687
|
+
# would be: `calendar.googleapis.com`.
|
|
4387
3688
|
# Corresponds to the JSON property `name`
|
|
4388
3689
|
# @return [String]
|
|
4389
3690
|
attr_accessor :name
|
|
4390
3691
|
|
|
4391
|
-
# Quota configuration helps to achieve fairness and budgeting in service
|
|
4392
|
-
#
|
|
4393
|
-
#
|
|
4394
|
-
#
|
|
4395
|
-
#
|
|
4396
|
-
#
|
|
4397
|
-
#
|
|
4398
|
-
#
|
|
4399
|
-
#
|
|
4400
|
-
#
|
|
4401
|
-
#
|
|
4402
|
-
# -
|
|
4403
|
-
#
|
|
4404
|
-
#
|
|
4405
|
-
#
|
|
4406
|
-
#
|
|
4407
|
-
#
|
|
4408
|
-
#
|
|
4409
|
-
#
|
|
4410
|
-
# # consuming at twice rate as the DeleteBook method.
|
|
4411
|
-
# metric_rules:
|
|
4412
|
-
# - selector: "*"
|
|
4413
|
-
# metric_costs:
|
|
4414
|
-
# library.googleapis.com/read_calls: 1
|
|
4415
|
-
# - selector: google.example.library.v1.LibraryService.UpdateBook
|
|
4416
|
-
# metric_costs:
|
|
4417
|
-
# library.googleapis.com/write_calls: 2
|
|
4418
|
-
# - selector: google.example.library.v1.LibraryService.DeleteBook
|
|
4419
|
-
# metric_costs:
|
|
4420
|
-
# library.googleapis.com/write_calls: 1
|
|
4421
|
-
# Corresponding Metric definition:
|
|
4422
|
-
# metrics:
|
|
4423
|
-
# - name: library.googleapis.com/read_calls
|
|
4424
|
-
# display_name: Read requests
|
|
4425
|
-
# metric_kind: DELTA
|
|
4426
|
-
# value_type: INT64
|
|
4427
|
-
# - name: library.googleapis.com/write_calls
|
|
4428
|
-
# display_name: Write requests
|
|
4429
|
-
# metric_kind: DELTA
|
|
4430
|
-
# value_type: INT64
|
|
3692
|
+
# Quota configuration helps to achieve fairness and budgeting in service usage.
|
|
3693
|
+
# The metric based quota configuration works this way: - The service
|
|
3694
|
+
# configuration defines a set of metrics. - For API calls, the quota.
|
|
3695
|
+
# metric_rules maps methods to metrics with corresponding costs. - The quota.
|
|
3696
|
+
# limits defines limits on the metrics, which will be used for quota checks at
|
|
3697
|
+
# runtime. An example quota configuration in yaml format: quota: limits: - name:
|
|
3698
|
+
# apiWriteQpsPerProject metric: library.googleapis.com/write_calls unit: "1/min/`
|
|
3699
|
+
# project`" # rate limit for consumer projects values: STANDARD: 10000 # The
|
|
3700
|
+
# metric rules bind all methods to the read_calls metric, # except for the
|
|
3701
|
+
# UpdateBook and DeleteBook methods. These two methods # are mapped to the
|
|
3702
|
+
# write_calls metric, with the UpdateBook method # consuming at twice rate as
|
|
3703
|
+
# the DeleteBook method. metric_rules: - selector: "*" metric_costs: library.
|
|
3704
|
+
# googleapis.com/read_calls: 1 - selector: google.example.library.v1.
|
|
3705
|
+
# LibraryService.UpdateBook metric_costs: library.googleapis.com/write_calls: 2 -
|
|
3706
|
+
# selector: google.example.library.v1.LibraryService.DeleteBook metric_costs:
|
|
3707
|
+
# library.googleapis.com/write_calls: 1 Corresponding Metric definition: metrics:
|
|
3708
|
+
# - name: library.googleapis.com/read_calls display_name: Read requests
|
|
3709
|
+
# metric_kind: DELTA value_type: INT64 - name: library.googleapis.com/
|
|
3710
|
+
# write_calls display_name: Write requests metric_kind: DELTA value_type: INT64
|
|
4431
3711
|
# Corresponds to the JSON property `quota`
|
|
4432
3712
|
# @return [Google::Apis::ServiceusageV1beta1::Quota]
|
|
4433
3713
|
attr_accessor :quota
|
|
@@ -4464,15 +3744,14 @@ module Google
|
|
|
4464
3744
|
class ServiceIdentity
|
|
4465
3745
|
include Google::Apis::Core::Hashable
|
|
4466
3746
|
|
|
4467
|
-
# The email address of the service account that a service producer would use
|
|
4468
|
-
#
|
|
3747
|
+
# The email address of the service account that a service producer would use to
|
|
3748
|
+
# access consumer resources.
|
|
4469
3749
|
# Corresponds to the JSON property `email`
|
|
4470
3750
|
# @return [String]
|
|
4471
3751
|
attr_accessor :email
|
|
4472
3752
|
|
|
4473
|
-
# The unique and stable id of the service account.
|
|
4474
|
-
#
|
|
4475
|
-
# ServiceAccount
|
|
3753
|
+
# The unique and stable id of the service account. https://cloud.google.com/iam/
|
|
3754
|
+
# reference/rest/v1/projects.serviceAccounts#ServiceAccount
|
|
4476
3755
|
# Corresponds to the JSON property `uniqueId`
|
|
4477
3756
|
# @return [String]
|
|
4478
3757
|
attr_accessor :unique_id
|
|
@@ -4488,13 +3767,13 @@ module Google
|
|
|
4488
3767
|
end
|
|
4489
3768
|
end
|
|
4490
3769
|
|
|
4491
|
-
# `SourceContext` represents information about the source of a
|
|
4492
|
-
#
|
|
3770
|
+
# `SourceContext` represents information about the source of a protobuf element,
|
|
3771
|
+
# like the file in which it is defined.
|
|
4493
3772
|
class SourceContext
|
|
4494
3773
|
include Google::Apis::Core::Hashable
|
|
4495
3774
|
|
|
4496
3775
|
# The path-qualified name of the .proto file that contained the associated
|
|
4497
|
-
# protobuf element.
|
|
3776
|
+
# protobuf element. For example: `"google/protobuf/source_context.proto"`.
|
|
4498
3777
|
# Corresponds to the JSON property `fileName`
|
|
4499
3778
|
# @return [String]
|
|
4500
3779
|
attr_accessor :file_name
|
|
@@ -4528,12 +3807,12 @@ module Google
|
|
|
4528
3807
|
end
|
|
4529
3808
|
end
|
|
4530
3809
|
|
|
4531
|
-
# The `Status` type defines a logical error model that is suitable for
|
|
4532
|
-
#
|
|
4533
|
-
#
|
|
4534
|
-
#
|
|
4535
|
-
#
|
|
4536
|
-
#
|
|
3810
|
+
# The `Status` type defines a logical error model that is suitable for different
|
|
3811
|
+
# programming environments, including REST APIs and RPC APIs. It is used by [
|
|
3812
|
+
# gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
|
|
3813
|
+
# data: error code, error message, and error details. You can find out more
|
|
3814
|
+
# about this error model and how to work with it in the [API Design Guide](https:
|
|
3815
|
+
# //cloud.google.com/apis/design/errors).
|
|
4537
3816
|
class Status
|
|
4538
3817
|
include Google::Apis::Core::Hashable
|
|
4539
3818
|
|
|
@@ -4542,15 +3821,15 @@ module Google
|
|
|
4542
3821
|
# @return [Fixnum]
|
|
4543
3822
|
attr_accessor :code
|
|
4544
3823
|
|
|
4545
|
-
# A list of messages that carry the error details.
|
|
3824
|
+
# A list of messages that carry the error details. There is a common set of
|
|
4546
3825
|
# message types for APIs to use.
|
|
4547
3826
|
# Corresponds to the JSON property `details`
|
|
4548
3827
|
# @return [Array<Hash<String,Object>>]
|
|
4549
3828
|
attr_accessor :details
|
|
4550
3829
|
|
|
4551
|
-
# A developer-facing error message, which should be in English. Any
|
|
4552
|
-
#
|
|
4553
|
-
#
|
|
3830
|
+
# A developer-facing error message, which should be in English. Any user-facing
|
|
3831
|
+
# error message should be localized and sent in the google.rpc.Status.details
|
|
3832
|
+
# field, or localized by the client.
|
|
4554
3833
|
# Corresponds to the JSON property `message`
|
|
4555
3834
|
# @return [String]
|
|
4556
3835
|
attr_accessor :message
|
|
@@ -4573,8 +3852,7 @@ module Google
|
|
|
4573
3852
|
class SystemParameter
|
|
4574
3853
|
include Google::Apis::Core::Hashable
|
|
4575
3854
|
|
|
4576
|
-
# Define the HTTP header name to use for the parameter. It is case
|
|
4577
|
-
# insensitive.
|
|
3855
|
+
# Define the HTTP header name to use for the parameter. It is case insensitive.
|
|
4578
3856
|
# Corresponds to the JSON property `httpHeader`
|
|
4579
3857
|
# @return [String]
|
|
4580
3858
|
attr_accessor :http_header
|
|
@@ -4602,23 +3880,20 @@ module Google
|
|
|
4602
3880
|
end
|
|
4603
3881
|
end
|
|
4604
3882
|
|
|
4605
|
-
# Define a system parameter rule mapping system parameter definitions to
|
|
4606
|
-
# methods.
|
|
3883
|
+
# Define a system parameter rule mapping system parameter definitions to methods.
|
|
4607
3884
|
class SystemParameterRule
|
|
4608
3885
|
include Google::Apis::Core::Hashable
|
|
4609
3886
|
|
|
4610
|
-
# Define parameters. Multiple names may be defined for a parameter.
|
|
4611
|
-
#
|
|
4612
|
-
#
|
|
4613
|
-
#
|
|
4614
|
-
# parameter-dependent.
|
|
3887
|
+
# Define parameters. Multiple names may be defined for a parameter. For a given
|
|
3888
|
+
# method call, only one of them should be used. If multiple names are used the
|
|
3889
|
+
# behavior is implementation-dependent. If none of the specified names are
|
|
3890
|
+
# present the behavior is parameter-dependent.
|
|
4615
3891
|
# Corresponds to the JSON property `parameters`
|
|
4616
3892
|
# @return [Array<Google::Apis::ServiceusageV1beta1::SystemParameter>]
|
|
4617
3893
|
attr_accessor :parameters
|
|
4618
3894
|
|
|
4619
3895
|
# Selects the methods to which this rule applies. Use '*' to indicate all
|
|
4620
|
-
# methods in all APIs.
|
|
4621
|
-
# Refer to selector for syntax details.
|
|
3896
|
+
# methods in all APIs. Refer to selector for syntax details.
|
|
4622
3897
|
# Corresponds to the JSON property `selector`
|
|
4623
3898
|
# @return [String]
|
|
4624
3899
|
attr_accessor :selector
|
|
@@ -4634,36 +3909,23 @@ module Google
|
|
|
4634
3909
|
end
|
|
4635
3910
|
end
|
|
4636
3911
|
|
|
4637
|
-
# ### System parameter configuration
|
|
4638
|
-
#
|
|
4639
|
-
#
|
|
4640
|
-
#
|
|
4641
|
-
# change the names of the system parameters.
|
|
3912
|
+
# ### System parameter configuration A system parameter is a special kind of
|
|
3913
|
+
# parameter defined by the API system, not by an individual API. It is typically
|
|
3914
|
+
# mapped to an HTTP header and/or a URL query parameter. This configuration
|
|
3915
|
+
# specifies which methods change the names of the system parameters.
|
|
4642
3916
|
class SystemParameters
|
|
4643
3917
|
include Google::Apis::Core::Hashable
|
|
4644
3918
|
|
|
4645
|
-
# Define system parameters.
|
|
4646
|
-
#
|
|
4647
|
-
#
|
|
4648
|
-
#
|
|
4649
|
-
#
|
|
4650
|
-
# Example: define api key for
|
|
4651
|
-
# system_parameters
|
|
4652
|
-
#
|
|
4653
|
-
# -
|
|
4654
|
-
#
|
|
4655
|
-
# - name: api_key
|
|
4656
|
-
# url_query_parameter: api_key
|
|
4657
|
-
# Example: define 2 api key names for a specific method.
|
|
4658
|
-
# system_parameters
|
|
4659
|
-
# rules:
|
|
4660
|
-
# - selector: "/ListShelves"
|
|
4661
|
-
# parameters:
|
|
4662
|
-
# - name: api_key
|
|
4663
|
-
# http_header: Api-Key1
|
|
4664
|
-
# - name: api_key
|
|
4665
|
-
# http_header: Api-Key2
|
|
4666
|
-
# **NOTE:** All service configuration rules follow "last one wins" order.
|
|
3919
|
+
# Define system parameters. The parameters defined here will override the
|
|
3920
|
+
# default parameters implemented by the system. If this field is missing from
|
|
3921
|
+
# the service config, default system parameters will be used. Default system
|
|
3922
|
+
# parameters and names is implementation-dependent. Example: define api key for
|
|
3923
|
+
# all methods system_parameters rules: - selector: "*" parameters: - name:
|
|
3924
|
+
# api_key url_query_parameter: api_key Example: define 2 api key names for a
|
|
3925
|
+
# specific method. system_parameters rules: - selector: "/ListShelves"
|
|
3926
|
+
# parameters: - name: api_key http_header: Api-Key1 - name: api_key http_header:
|
|
3927
|
+
# Api-Key2 **NOTE:** All service configuration rules follow "last one wins"
|
|
3928
|
+
# order.
|
|
4667
3929
|
# Corresponds to the JSON property `rules`
|
|
4668
3930
|
# @return [Array<Google::Apis::ServiceusageV1beta1::SystemParameterRule>]
|
|
4669
3931
|
attr_accessor :rules
|
|
@@ -4702,8 +3964,8 @@ module Google
|
|
|
4702
3964
|
# @return [Array<Google::Apis::ServiceusageV1beta1::Option>]
|
|
4703
3965
|
attr_accessor :options
|
|
4704
3966
|
|
|
4705
|
-
# `SourceContext` represents information about the source of a
|
|
4706
|
-
#
|
|
3967
|
+
# `SourceContext` represents information about the source of a protobuf element,
|
|
3968
|
+
# like the file in which it is defined.
|
|
4707
3969
|
# Corresponds to the JSON property `sourceContext`
|
|
4708
3970
|
# @return [Google::Apis::ServiceusageV1beta1::SourceContext]
|
|
4709
3971
|
attr_accessor :source_context
|
|
@@ -4733,37 +3995,33 @@ module Google
|
|
|
4733
3995
|
include Google::Apis::Core::Hashable
|
|
4734
3996
|
|
|
4735
3997
|
# The full resource name of a channel used for sending notifications to the
|
|
4736
|
-
# service producer.
|
|
4737
|
-
#
|
|
4738
|
-
#
|
|
4739
|
-
#
|
|
4740
|
-
#
|
|
4741
|
-
# documented in https://cloud.google.com/pubsub/docs/overview.
|
|
3998
|
+
# service producer. Google Service Management currently only supports [Google
|
|
3999
|
+
# Cloud Pub/Sub](https://cloud.google.com/pubsub) as a notification channel. To
|
|
4000
|
+
# use Google Cloud Pub/Sub as the channel, this must be the name of a Cloud Pub/
|
|
4001
|
+
# Sub topic that uses the Cloud Pub/Sub topic name format documented in https://
|
|
4002
|
+
# cloud.google.com/pubsub/docs/overview.
|
|
4742
4003
|
# Corresponds to the JSON property `producerNotificationChannel`
|
|
4743
4004
|
# @return [String]
|
|
4744
4005
|
attr_accessor :producer_notification_channel
|
|
4745
4006
|
|
|
4746
4007
|
# Requirements that must be satisfied before a consumer project can use the
|
|
4747
|
-
# service. Each requirement is of the form
|
|
4748
|
-
#
|
|
4008
|
+
# service. Each requirement is of the form /; for example 'serviceusage.
|
|
4009
|
+
# googleapis.com/billing-enabled'.
|
|
4749
4010
|
# Corresponds to the JSON property `requirements`
|
|
4750
4011
|
# @return [Array<String>]
|
|
4751
4012
|
attr_accessor :requirements
|
|
4752
4013
|
|
|
4753
|
-
# A list of usage rules that apply to individual API methods.
|
|
4754
|
-
#
|
|
4014
|
+
# A list of usage rules that apply to individual API methods. **NOTE:** All
|
|
4015
|
+
# service configuration rules follow "last one wins" order.
|
|
4755
4016
|
# Corresponds to the JSON property `rules`
|
|
4756
4017
|
# @return [Array<Google::Apis::ServiceusageV1beta1::UsageRule>]
|
|
4757
4018
|
attr_accessor :rules
|
|
4758
4019
|
|
|
4759
|
-
# The per-product per-project service identity for a service.
|
|
4760
|
-
#
|
|
4761
|
-
#
|
|
4762
|
-
#
|
|
4763
|
-
#
|
|
4764
|
-
# - service_account_parent: "projects/123456789"
|
|
4765
|
-
# display_name: "Cloud XXX Service Agent"
|
|
4766
|
-
# description: "Used as the identity of Cloud XXX to access resources"
|
|
4020
|
+
# The per-product per-project service identity for a service. Use this field to
|
|
4021
|
+
# configure per-product per-project service identity. Example of a service
|
|
4022
|
+
# identity configuration. usage: service_identity: - service_account_parent: "
|
|
4023
|
+
# projects/123456789" display_name: "Cloud XXX Service Agent" description: "Used
|
|
4024
|
+
# as the identity of Cloud XXX to access resources"
|
|
4767
4025
|
# Corresponds to the JSON property `serviceIdentity`
|
|
4768
4026
|
# @return [Google::Apis::ServiceusageV1beta1::GoogleApiServiceIdentity]
|
|
4769
4027
|
attr_accessor :service_identity
|
|
@@ -4781,45 +4039,36 @@ module Google
|
|
|
4781
4039
|
end
|
|
4782
4040
|
end
|
|
4783
4041
|
|
|
4784
|
-
# Usage configuration rules for the service.
|
|
4785
|
-
#
|
|
4786
|
-
#
|
|
4787
|
-
#
|
|
4788
|
-
#
|
|
4789
|
-
#
|
|
4790
|
-
#
|
|
4791
|
-
#
|
|
4792
|
-
#
|
|
4793
|
-
#
|
|
4794
|
-
# rules:
|
|
4795
|
-
# - selector: "*"
|
|
4796
|
-
# allow_unregistered_calls: true
|
|
4797
|
-
# Example of a method that wants to allow unregistered calls.
|
|
4798
|
-
# usage:
|
|
4799
|
-
# rules:
|
|
4800
|
-
# - selector: "google.example.library.v1.LibraryService.CreateBook"
|
|
4801
|
-
# allow_unregistered_calls: true
|
|
4042
|
+
# Usage configuration rules for the service. NOTE: Under development. Use this
|
|
4043
|
+
# rule to configure unregistered calls for the service. Unregistered calls are
|
|
4044
|
+
# calls that do not contain consumer project identity. (Example: calls that do
|
|
4045
|
+
# not contain an API key). By default, API methods do not allow unregistered
|
|
4046
|
+
# calls, and each method call must be identified by a consumer project identity.
|
|
4047
|
+
# Use this rule to allow/disallow unregistered calls. Example of an API that
|
|
4048
|
+
# wants to allow unregistered calls for entire service. usage: rules: - selector:
|
|
4049
|
+
# "*" allow_unregistered_calls: true Example of a method that wants to allow
|
|
4050
|
+
# unregistered calls. usage: rules: - selector: "google.example.library.v1.
|
|
4051
|
+
# LibraryService.CreateBook" allow_unregistered_calls: true
|
|
4802
4052
|
class UsageRule
|
|
4803
4053
|
include Google::Apis::Core::Hashable
|
|
4804
4054
|
|
|
4805
|
-
# If true, the selected method allows unregistered calls, e.g. calls
|
|
4806
|
-
#
|
|
4055
|
+
# If true, the selected method allows unregistered calls, e.g. calls that don't
|
|
4056
|
+
# identify any user or application.
|
|
4807
4057
|
# Corresponds to the JSON property `allowUnregisteredCalls`
|
|
4808
4058
|
# @return [Boolean]
|
|
4809
4059
|
attr_accessor :allow_unregistered_calls
|
|
4810
4060
|
alias_method :allow_unregistered_calls?, :allow_unregistered_calls
|
|
4811
4061
|
|
|
4812
4062
|
# Selects the methods to which this rule applies. Use '*' to indicate all
|
|
4813
|
-
# methods in all APIs.
|
|
4814
|
-
# Refer to selector for syntax details.
|
|
4063
|
+
# methods in all APIs. Refer to selector for syntax details.
|
|
4815
4064
|
# Corresponds to the JSON property `selector`
|
|
4816
4065
|
# @return [String]
|
|
4817
4066
|
attr_accessor :selector
|
|
4818
4067
|
|
|
4819
|
-
# If true, the selected method should skip service control and the control
|
|
4820
|
-
#
|
|
4821
|
-
#
|
|
4822
|
-
#
|
|
4068
|
+
# If true, the selected method should skip service control and the control plane
|
|
4069
|
+
# features, such as quota and billing, will not be available. This flag is used
|
|
4070
|
+
# by Google Cloud Endpoints to bypass checks for internal methods, such as
|
|
4071
|
+
# service health check methods.
|
|
4823
4072
|
# Corresponds to the JSON property `skipServiceControl`
|
|
4824
4073
|
# @return [Boolean]
|
|
4825
4074
|
attr_accessor :skip_service_control
|